Cisco-IOS-XR-infra-policymgr-cfg API API Reference
API generated from Cisco-IOS-XR-infra-policymgr-cfg@2018-06-29.yang
API Endpoint
http://{Controller-IP}:{Controller-Port}/restconf/config/network-topology:network-topology/topology/topology-netconf/node/inetri/yang-ext:mount/
URL '/' code: %2F
Schemes: http
Version: 1.0.0
Leaf Color Code:
Key  Mandatory  OptionalPaths
POLICY-MANAGER - Update
Update operation of resource: policy-manager
policy-managerbody object
Request Content-Types: application/json
Request Example
{ { {
"event-mode-match-all": [ null ], Execute all the matched classes.
"event-type": "enumeration", Event type.
Options:
account-logoff
account-logon
authentication-failure
authentication-no-response
authorization-failure
authorization-no-response
credit-exhausted
exception
idle-timeout
quota-depleted
service-start
service-stop
session-activate
session-start
session-stop
timer-expiry { { "aaa-list": "string", Name of the AAA method list.
"password": "string", Specify a password to be used for AAA\nrequest.
"identifier": "enumeration", Specify an Authorize format name.
Options:
circuit-id
dhcp-client-id
remote-id
source-address-ipv4
source-address-ipv6
source-address-mac
username
"format": "string" Domain-format name.
}, "aaa-list": "string", Name of the AAA method list.
"name": "string" Domain name or regular expression.
}, "aaa-list": "string" Name of the AAA method list.
},
"disconnect": [ null ], Disconnect session.
"monitor": [ null ], Monitor session.
"action-sequence-number": "integer", Sequence number for this action.
range: "1..65535" "timer-value": "integer", Timer value in minutes.
units: "minutes"
"timer-name": "string" Name of the timer.
}, "timer-name": "string" Name of the timer.
}, "aaa-list": "string", Name of the AAA method list.
"name": "string" Domain name or regular expression.
}
}
],
"class-execution-strategy": "enumeration", Class execution strategy.
Options:
do-all
do-until-failure
do-until-success
"class-name": "string", Name of class-map.
"class-type": "enumeration" Type of class-map.
Options:
qos
traffic
subscriber-control
}
],
"event-mode-match-first": [ null ] Execute only the first matched class.
}
], { "unit": "string", Remaining bandwidth units.
"value": "integer" Dhcp client Id.
}, "unit": "string", Remaining bandwidth units.
"value": "integer" Dhcp client Id.
},
"pfc-pause-set": [ null ], Pfc Pause set value. "unit": "string", Remaining bandwidth units.
"value": "integer" Dhcp client Id.
}
}, "index": "integer", ASN2:index 2/4 byte (hex or decimal format)
range: "1..255"
"path-id": "integer", Service function path id.
range: "1..16777215"
"metadata": "string" Service function path metadata name.
},
"default-red": [ null ], Default random early detection
"pbr-transmit": [ null ], Policy action PBR transmit.
"fragment": "string", Policy action fragment. Fragment name "dei": "integer", Match DEI bit.
range: "0..1"
"cos": "integer", Match CoS.
range: "0..7"
"inner-cos": "integer", Match inner CoS.
range: "0..7"
"forward-class": "integer", Sets the forward class.
range: "0..7"
"precedence": "string", Match precedence.
range: "0..7"
"srp-priority": "integer", Sets the spatial reuse protocol priority value of an\noutgoing packet.
range: "0..7"
"df": "integer", Set DF bit.
range: "0..1"
"fr-de": "integer", Match FrameRelay DE bit.
range: "0..1"
"dscp-tunnel": "string", Marks a packet by setting DSCP in the tunnel header.\nThis is specific to ipsec tunnels
"mpls-experimental-top-most": "integer", Sets the experimental value of the MPLS packet top-most\nlabels.
range: "0..7"
"dscp": "string", Match DSCP.
"mpls-experimental-imposition": "integer", Match MPLS experimental imposition label.
range: "0..7"
"qos-group": "integer", Match QoS group.\nShould be value 0..512 or range.
range: "0..512"
"traffic-class": "integer", Match Traffic Class.\nShould be value 0..63 or range.
range: "0..63"
"destination-address": "string", Destination IPv4 address.
"precedence-tunnel": "string", Sets the precedence tunnel value for ipsec.
range: "0..7"
"source-address": "string", Source IPv4 address.
"discard-class": "integer", Match discard class.
range: "0..7"
"dei-imposition": "integer", Set DEI imposition bit.
range: "0..1"
"atm-clp": [ null ] Match ATM CLP bit.
}, "index": "integer", ASN2:index 2/4 byte (hex or decimal format)
range: "0..4294967295" "netmask": "string", IPv4 netmask.
"address": "string" IPv4 address.
},
"as-number": "integer" 2-byte/4-byte AS number
range: "1..4294967295"
}
}, "ipv4-next-hop": "string", IPv4 address.
"vrf": "string" VRF name.
}, "ipv6-next-hop": "string", IPv6 address.
"vrf": "string" VRF name.
}
},
"class-name": "string", Name of class-map.
"ecn-red": [ null ], ECN based random early detection "criterion-packet-rate": [ null ], React criterion packet rate.
"criterion-media-stop": [ null ], React criterion media stop.
"criterion-flow-count": [ null ], React criterion flow count. "group-count": "integer", Number of flows to reach before\ntriggering alarm
units: "number of flows"
"discrete": [ null ], Discrete alarm type.
"group-percent": "integer" Percent to reach before triggering alarm
units: "percentage"
},
"severity": "string" Severity of the alarm.
}, "less-than-equal": "string", Less than equal
"range": "string", Range
"greater-than-equal": "string", Greater than equal
"less-than": "string", Less than
"greater-than": "string" Greater than
}, "average": "integer", Trigger averaged over N intervals.
"immediate": [ null ] Immediate trigger.
}
},
"criterion-delay-factor": [ null ], React criterion delay factor.
"descrition": "string", String describing the react statement. "syslog": [ null ], Syslog.
"snmp": [ null ] SNMP.
},
"criterion-mrv": [ null ] React criterion mrv.
}, "unit": "string", Remaining bandwidth units.
"value": "integer" Dhcp client Id.
}, "units": "string", Rate units.
"value": "integer" Dhcp client Id.
}
},
"pbr-drop": [ null ], Policy action PBR drop.
"priority-level": "integer", Priority level.
range: "1..7"
"service-fragment": "string", Policy action service fragment.\nService fragment name "unit": "string", Remaining bandwidth units.
"value": "integer" Dhcp client Id.
}, "Transmit": [ null ], Police action transmit.
"drop": [ null ], Police action drop. "dei": "integer", Match DEI bit.
range: "0..1"
"cos": "integer", Match CoS.
range: "0..7"
"inner-cos": "integer", Match inner CoS.
range: "0..7"
"forward-class": "integer", Sets the forward class.
range: "0..7"
"precedence": "string", Match precedence.
range: "0..7"
"srp-priority": "integer", Sets the spatial reuse protocol priority value of an\noutgoing packet.
range: "0..7"
"df": "integer", Set DF bit.
range: "0..1"
"fr-de": "integer", Match FrameRelay DE bit.
range: "0..1"
"dscp-tunnel": "string", Marks a packet by setting DSCP in the tunnel header.\nThis is specific to ipsec tunnels
"mpls-experimental-top-most": "integer", Sets the experimental value of the MPLS packet top-most\nlabels.
range: "0..7"
"dscp": "string", Match DSCP.
"mpls-experimental-imposition": "integer", Match MPLS experimental imposition label.
range: "0..7"
"qos-group": "integer", Match QoS group.\nShould be value 0..512 or range.
range: "0..512"
"traffic-class": "integer", Match Traffic Class.\nShould be value 0..63 or range.
range: "0..63"
"destination-address": "string", Destination IPv4 address.
"precedence-tunnel": "string", Sets the precedence tunnel value for ipsec.
range: "0..7"
"source-address": "string", Source IPv4 address.
"discard-class": "integer", Match discard class.
range: "0..7"
"dei-imposition": "integer", Set DEI imposition bit.
range: "0..1"
"atm-clp": [ null ] Match ATM CLP bit.
}
}, "units": "string", Rate units.
"value": "integer" Dhcp client Id.
}, "units": "string", Rate units.
"value": "integer" Dhcp client Id.
}, "units": "string", Rate units.
"value": "integer" Dhcp client Id.
}, "Transmit": [ null ], Police action transmit.
"drop": [ null ], Police action drop. "dei": "integer", Match DEI bit.
range: "0..1"
"cos": "integer", Match CoS.
range: "0..7"
"inner-cos": "integer", Match inner CoS.
range: "0..7"
"forward-class": "integer", Sets the forward class.
range: "0..7"
"precedence": "string", Match precedence.
range: "0..7"
"srp-priority": "integer", Sets the spatial reuse protocol priority value of an\noutgoing packet.
range: "0..7"
"df": "integer", Set DF bit.
range: "0..1"
"fr-de": "integer", Match FrameRelay DE bit.
range: "0..1"
"dscp-tunnel": "string", Marks a packet by setting DSCP in the tunnel header.\nThis is specific to ipsec tunnels
"mpls-experimental-top-most": "integer", Sets the experimental value of the MPLS packet top-most\nlabels.
range: "0..7"
"dscp": "string", Match DSCP.
"mpls-experimental-imposition": "integer", Match MPLS experimental imposition label.
range: "0..7"
"qos-group": "integer", Match QoS group.\nShould be value 0..512 or range.
range: "0..512"
"traffic-class": "integer", Match Traffic Class.\nShould be value 0..63 or range.
range: "0..63"
"destination-address": "string", Destination IPv4 address.
"precedence-tunnel": "string", Sets the precedence tunnel value for ipsec.
range: "0..7"
"source-address": "string", Source IPv4 address.
"discard-class": "integer", Match discard class.
range: "0..7"
"dei-imposition": "integer", Set DEI imposition bit.
range: "0..1"
"atm-clp": [ null ] Match ATM CLP bit.
}
}, "units": "string", Rate units.
"value": "integer" Dhcp client Id.
}, "Transmit": [ null ], Police action transmit.
"drop": [ null ], Police action drop. "dei": "integer", Match DEI bit.
range: "0..1"
"cos": "integer", Match CoS.
range: "0..7"
"inner-cos": "integer", Match inner CoS.
range: "0..7"
"forward-class": "integer", Sets the forward class.
range: "0..7"
"precedence": "string", Match precedence.
range: "0..7"
"srp-priority": "integer", Sets the spatial reuse protocol priority value of an\noutgoing packet.
range: "0..7"
"df": "integer", Set DF bit.
range: "0..1"
"fr-de": "integer", Match FrameRelay DE bit.
range: "0..1"
"dscp-tunnel": "string", Marks a packet by setting DSCP in the tunnel header.\nThis is specific to ipsec tunnels
"mpls-experimental-top-most": "integer", Sets the experimental value of the MPLS packet top-most\nlabels.
range: "0..7"
"dscp": "string", Match DSCP.
"mpls-experimental-imposition": "integer", Match MPLS experimental imposition label.
range: "0..7"
"qos-group": "integer", Match QoS group.\nShould be value 0..512 or range.
range: "0..512"
"traffic-class": "integer", Match Traffic Class.\nShould be value 0..63 or range.
range: "0..63"
"destination-address": "string", Destination IPv4 address.
"precedence-tunnel": "string", Sets the precedence tunnel value for ipsec.
range: "0..7"
"source-address": "string", Source IPv4 address.
"discard-class": "integer", Match discard class.
range: "0..7"
"dei-imposition": "integer", Set DEI imposition bit.
range: "0..1"
"atm-clp": [ null ] Match ATM CLP bit.
}
}
}, "subscriberip": [ null ], Subscriber IP
"hostname": [ null ], Hostname
"subscribermac": [ null ], Subscriber Mac
"bngidentifierinterface": [ null ] Bng Identifier Interface
}, "layer3": "integer", Nominal rate specified at the L3 (IP).
units: "bps"
"media": "integer", Nominal data rate of the media flow (ip payload).
range: "1..3000000000"
units: "bps"
"packet": "integer" Nominal IP layer packet rate (in pps).
units: "pps"
}, "count-in-layer3": "integer", Nominal number of media packets in an IP payload.
range: "1..64"
units: "packets"
"size": "integer" Nominal size of the media-packet.
units: "bytes"
}
}, "flow-idle-timeout": "string", The interval after which a flow is removed,\nif there is no activity.\nIf timeout is 0 this flow does not expire. "units": "string", Rate units.
"value": "integer" Dhcp client Id.
range: "1..4294967295"
}, "units": "string", Rate units.
"value": "integer" Dhcp client Id.
range: "1..4294967295"
}
}, "unit": "string", Remaining bandwidth units.
"value": "integer" Dhcp client Id.
},
"http-redirect": "string", Policy action http redirect.\nRedirect to this url. "default": [ null ], Use system default routing table. : { "ipv6-address": "string", IPv6 address.
"ipv4-address": "string", IPv4 address.
"vrf": "string" VRF name.
}
}, "max-flow": "integer", Max simultaneous flows monitored per policy class
range: "0..4096"
"interval-duration": "integer", Monitored interval duration.
units: "seconds"
"timeout": "integer", Declare a flow dead if no packets received in\nso much time
units: "seconds"
"history": "integer" Keep stats/metrics on box for so many intervals.
},
"class-type": "enumeration", Type of class-map.
Options:
qos
traffic
subscriber-control "policy-name": "string", Name of service-policy.
"type": "string" Type of class-map.
}, "unit": "string", Remaining bandwidth units.
"value": "integer" Dhcp client Id.
},
"decap-gre": [ null ], Policy action DECAP GRE. {
"cos": "string", Match CoS.
range: "0..7"
"threshold-max-value": "integer", Maximum RED threshold value.
"precedence": "string", Match precedence.
range: "0..7"
"threshold-min-value": "integer", Minimum RED threshold value.
"threshold-max-units": "string", Maximum RED threshold units.
"dscp": "string", Match DSCP.
"dei": "integer", Match DEI bit.
range: "0..1"
"threshold-min-units": "string", Minimum RED threshold units.
"ecn": [ null ], ECN based WRED.
"discard-class": "string", Match discard class.
range: "0..7"
"mpls-exp": "string" MPLS Experimental value based WRED.
range: "0..7"
}
]
}
],
"type": "enumeration", Type of class-map.
Options:
qos
pbr
traffic
subscriber-control
accounting
redirect
flow-monitor
"description": "string", Description for this policy-map.
"name": "string" Domain name or regular expression.
}
]
}, { {
"class-map-mode-match-any": [ null ], Match all match criteria
"name": "string", Domain name or regular expression. "service-name-regex": "string", Match servicve name regular expression.
"protocol": "string", Match protocol.
"vpls-broadcast": [ null ], Match VPLS Broadcast
"precedence": "string", Match precedence.
range: "0..7"
"packet-length": "string", Match packet length.\nShould be value 0..65535 or range.
"fr-de": "integer", Match FrameRelay DE bit.
range: "0..1"
"circuit-id-regex": "string", Match Circuit id regex.
"traffic-class": "string", Match Traffic Class.\nShould be value 0..63 or range.
"ipv6-packet-length": "string", Match IPv6 packet length.\nShould be value 0..65535 or range.
"icmpv6-code": "string", Match IPv6 ICMP code.\nShould be value 0..255 or range.
"timer": "string", Match timer.
"vpls-multicast": [ null ], Match VPLS Multicast
"service-name": "string", Match servicve name.
"fragment-type": "string", Match fragment type for a packet.
"flow-tag": "string", Match flow-tag. Should be value 1..63 or range.
"ipv4-packet-length": "string", Match IPv4 packet length.\nShould be value 0..65535 or range. {
"netmask": "string", IPv4 netmask.
"address": "string" IPv4 address.
}
], {
"prefix-length": "integer", IPv6 prefix length.
range: "0..128"
"address": "string" IPv4 address.
}
],
"authen-status": "string", Match authentication status.
"ipv4-precedence": "string", Match IPv4 precedence.
range: "0..7"
"ipv4-dscp": "string", Match IPv4 DSCP.
"tcp-flag": "integer", Match TCP flags.
range: "0..4095"
"ethertype": "string", Match Ethertype.
"mpls-experimental-topmost": "string", Match MPLS experimental topmost label.
range: "0..7"
"ethernet-services-acl": "string", Match Ethernet Services {
"flag": "string", Dhcp client id Ascii/Hex
"value": "string" Dhcp client Id.
}
],
"ipv4-acl": "string", Match IPv4 ACL.
"icmpv6-type": "string", Match IPv6 ICMP type.\nShould be value 0..255 or range.
"vpls-known": [ null ], Match VPLS Known
"destination-port": "string", Match destination port.\nShould be value 0..65535 or range. {
"flag": "string", Dhcp client id Ascii/Hex
"value": "string" Dhcp client Id.
}
],
"inner-cos": "string", Match inner CoS.
range: "0..7"
"frame-relay-dlci": "string", Match frame-relay DLCI value.\nShould be value 16..1007 or range.
"vpls-unknown": [ null ], Match VPLS Unknown
"vlan": "string", Match VLAN ID.
"user-name": "string", Match user name.
"dscp": "string", Match DSCP.
"mpls-experimental-imposition": "string", Match MPLS experimental imposition label.
range: "0..7"
"qos-group": "string", Match QoS group.\nShould be value 0..512 or range.
"source-mac": "string", Match source MAC address.
"circuit-id": "string", Match Circuit ID.
"ipv6-acl": "string", Match IPv6 ACL.
"source-port": "string", Match source port.\nShould be value 0..65535 or range.
"user-name-regex": "string", Match user name regular expression. {
"prefix-length": "integer", IPv6 prefix length.
range: "0..128"
"address": "string" IPv4 address.
}
],
"inner-vlan": "string", Match inner VLAN ID. {
"flow-tag": "integer" Match flow-tag. Should be value 1..63 or range.
range: "1..63"
}
],
"cos": "string", Match CoS.
range: "0..7"
"mpls-disposition-ipv6-access-list": "string", Match MPLS Label Disposition IPv6 access list.
"destination-mac": "string", Match destination MAC address.
"dei-inner": "integer", Match DEI INNER bit.
range: "0..1"
"remote-id-regex": "string", Match remote id regex.
"timer-regex": "string", Match timer regular expression. {
"netmask": "string", IPv4 netmask.
"address": "string" IPv4 address.
}
], {
"regex": "string", Domain name or regular expression.
"format": "string" Domain-format name.
}
],
"ipv6-dscp": "string", Match IPv6 DSCP.
"dei": "integer", Match DEI bit.
range: "0..1"
"icmpv4-code": "string", Match IPv4 ICMP code.\nShould be value 0..255 or range. {
"name": "string", Domain name or regular expression.
"format": "string" Domain-format name.
}
],
"remote-id": "string", Match remote ID.
"icmpv4-type": "string", Match IPv4 ICMP type.\nShould be value 0..255 or range.
"discard-class": "string", Match discard class.
range: "0..7"
"mpls-disposition-ipv4-access-list": "string", Match MPLS Label Disposition IPv4 access list.
"vpls-control": [ null ], Match VPLS control
"ipv6-precedence": "string" Match IPv6 precedence.
range: "0..7"
},
"type": "enumeration", Type of class-map.
Options:
qos
traffic
control
"class-map-mode-match-all": [ null ], Match any match criteria. {
"service-name-regex": "string", Match servicve name regular expression.
"protocol": "string", Match protocol.
"vpls-broadcast": [ null ], Match VPLS Broadcast
"precedence": "string", Match precedence.
range: "0..7"
"packet-length": "string", Match packet length.\nShould be value 0..65535 or range.
"fr-de": "integer", Match FrameRelay DE bit.
range: "0..1"
"cac-admit": [ null ], Match CAC admitted.
"circuit-id-regex": "string", Match Circuit id regex.
"atm-clp": "integer", Match ATM CLP bit.
range: "0..1"
"traffic-class": "string", Match Traffic Class.\nShould be value 0..63 or range.
"ipv6-packet-length": "string", Match IPv6 packet length.\nShould be value 0..65535 or range.
"icmpv6-code": "string", Match IPv6 ICMP code.\nShould be value 0..255 or range.
"timer": "string", Match timer.
"vpls-multicast": [ null ], Match VPLS Multicast
"service-name": "string", Match servicve name.
"fragment-type": "string", Match fragment type for a packet.
"flow-tag": "string", Match flow-tag. Should be value 1..63 or range.
"ipv4-packet-length": "string", Match IPv4 packet length.\nShould be value 0..65535 or range. {
"netmask": "string", IPv4 netmask.
"address": "string" IPv4 address.
}
], {
"prefix-length": "integer", IPv6 prefix length.
range: "0..128"
"address": "string" IPv4 address.
}
],
"authen-status": "string", Match authentication status.
"ipv4-precedence": "string", Match IPv4 precedence.
range: "0..7"
"ipv4-dscp": "string", Match IPv4 DSCP.
"tcp-flag": "integer", Match TCP flags.
range: "0..4095"
"ethertype": "string", Match Ethertype.
"mpls-experimental-topmost": "string", Match MPLS experimental topmost label.
range: "0..7"
"ethernet-services-acl": "string", Match Ethernet Services {
"flag": "string", Dhcp client id Ascii/Hex
"value": "string" Dhcp client Id.
}
],
"ipv4-acl": "string", Match IPv4 ACL.
"cac-unadmit": [ null ], Match CAC unadmitted.
"icmpv6-type": "string", Match IPv6 ICMP type.\nShould be value 0..255 or range.
"vpls-known": [ null ], Match VPLS Known
"destination-port": "string", Match destination port.\nShould be value 0..65535 or range. {
"flag": "string", Dhcp client id Ascii/Hex
"value": "string" Dhcp client Id.
}
],
"inner-cos": "string", Match inner CoS.
range: "0..7"
"frame-relay-dlci": "string", Match frame-relay DLCI value.\nShould be value 16..1007 or range.
"vpls-unknown": [ null ], Match VPLS Unknown
"vlan": "string", Match VLAN ID.
"user-name": "string", Match user name.
"dscp": "string", Match DSCP.
"mpls-experimental-imposition": "string", Match MPLS experimental imposition label.
range: "0..7"
"qos-group": "string", Match QoS group.\nShould be value 0..512 or range.
"source-mac": "string", Match source MAC address.
"circuit-id": "string", Match Circuit ID.
"ipv6-acl": "string", Match IPv6 ACL.
"atm-oam": [ null ], Match ATM OAM.
"source-port": "string", Match source port.\nShould be value 0..65535 or range.
"user-name-regex": "string", Match user name regular expression. {
"prefix-length": "integer", IPv6 prefix length.
range: "0..128"
"address": "string" IPv4 address.
}
],
"inner-vlan": "string", Match inner VLAN ID.
"cos": "string", Match CoS.
range: "0..7"
"mpls-disposition-ipv6-access-list": "string", Match MPLS Label Disposition IPv6 access list.
"destination-mac": "string", Match destination MAC address.
"dei-inner": "integer", Match DEI INNER bit.
range: "0..1"
"remote-id-regex": "string", Match remote id regex.
"timer-regex": "string", Match timer regular expression. {
"netmask": "string", IPv4 netmask.
"address": "string" IPv4 address.
}
], "flow-key": "string", Configure the flow-key parameters. {
"idle-timeout": "string" Maximum time of inactivity for a flow.
}
]
}, {
"regex": "string", Domain name or regular expression.
"format": "string" Domain-format name.
}
],
"ipv6-dscp": "string", Match IPv6 DSCP.
"dei": "integer", Match DEI bit.
range: "0..1"
"icmpv4-code": "string", Match IPv4 ICMP code.\nShould be value 0..255 or range. {
"name": "string", Domain name or regular expression.
"format": "string" Domain-format name.
}
],
"remote-id": "string", Match remote ID.
"icmpv4-type": "string", Match IPv4 ICMP type.\nShould be value 0..255 or range.
"discard-class": "string", Match discard class.
range: "0..7"
"mpls-disposition-ipv4-access-list": "string", Match MPLS Label Disposition IPv4 access list.
"vpls-control": [ null ], Match VPLS control
"ipv6-precedence": "string" Match IPv6 precedence.
range: "0..7"
}
],
"description": "string" Description for this policy-map.
}
]
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
POLICY-MANAGER - Create
Create operation of resource: policy-manager
policy-managerbody object
Request Content-Types: application/json
Request Example
{ { {
"event-mode-match-all": [ null ], Execute all the matched classes.
"event-type": "enumeration", Event type.
Options:
account-logoff
account-logon
authentication-failure
authentication-no-response
authorization-failure
authorization-no-response
credit-exhausted
exception
idle-timeout
quota-depleted
service-start
service-stop
session-activate
session-start
session-stop
timer-expiry { { "aaa-list": "string", Name of the AAA method list.
"password": "string", Specify a password to be used for AAA\nrequest.
"identifier": "enumeration", Specify an Authorize format name.
Options:
circuit-id
dhcp-client-id
remote-id
source-address-ipv4
source-address-ipv6
source-address-mac
username
"format": "string" Domain-format name.
}, "aaa-list": "string", Name of the AAA method list.
"name": "string" Domain name or regular expression.
}, "aaa-list": "string" Name of the AAA method list.
},
"disconnect": [ null ], Disconnect session.
"monitor": [ null ], Monitor session.
"action-sequence-number": "integer", Sequence number for this action.
range: "1..65535" "timer-value": "integer", Timer value in minutes.
units: "minutes"
"timer-name": "string" Name of the timer.
}, "timer-name": "string" Name of the timer.
}, "aaa-list": "string", Name of the AAA method list.
"name": "string" Domain name or regular expression.
}
}
],
"class-execution-strategy": "enumeration", Class execution strategy.
Options:
do-all
do-until-failure
do-until-success
"class-name": "string", Name of class-map.
"class-type": "enumeration" Type of class-map.
Options:
qos
traffic
subscriber-control
}
],
"event-mode-match-first": [ null ] Execute only the first matched class.
}
], { "unit": "string", Remaining bandwidth units.
"value": "integer" Dhcp client Id.
}, "unit": "string", Remaining bandwidth units.
"value": "integer" Dhcp client Id.
},
"pfc-pause-set": [ null ], Pfc Pause set value. "unit": "string", Remaining bandwidth units.
"value": "integer" Dhcp client Id.
}
}, "index": "integer", ASN2:index 2/4 byte (hex or decimal format)
range: "1..255"
"path-id": "integer", Service function path id.
range: "1..16777215"
"metadata": "string" Service function path metadata name.
},
"default-red": [ null ], Default random early detection
"pbr-transmit": [ null ], Policy action PBR transmit.
"fragment": "string", Policy action fragment. Fragment name "dei": "integer", Match DEI bit.
range: "0..1"
"cos": "integer", Match CoS.
range: "0..7"
"inner-cos": "integer", Match inner CoS.
range: "0..7"
"forward-class": "integer", Sets the forward class.
range: "0..7"
"precedence": "string", Match precedence.
range: "0..7"
"srp-priority": "integer", Sets the spatial reuse protocol priority value of an\noutgoing packet.
range: "0..7"
"df": "integer", Set DF bit.
range: "0..1"
"fr-de": "integer", Match FrameRelay DE bit.
range: "0..1"
"dscp-tunnel": "string", Marks a packet by setting DSCP in the tunnel header.\nThis is specific to ipsec tunnels
"mpls-experimental-top-most": "integer", Sets the experimental value of the MPLS packet top-most\nlabels.
range: "0..7"
"dscp": "string", Match DSCP.
"mpls-experimental-imposition": "integer", Match MPLS experimental imposition label.
range: "0..7"
"qos-group": "integer", Match QoS group.\nShould be value 0..512 or range.
range: "0..512"
"traffic-class": "integer", Match Traffic Class.\nShould be value 0..63 or range.
range: "0..63"
"destination-address": "string", Destination IPv4 address.
"precedence-tunnel": "string", Sets the precedence tunnel value for ipsec.
range: "0..7"
"source-address": "string", Source IPv4 address.
"discard-class": "integer", Match discard class.
range: "0..7"
"dei-imposition": "integer", Set DEI imposition bit.
range: "0..1"
"atm-clp": [ null ] Match ATM CLP bit.
}, "index": "integer", ASN2:index 2/4 byte (hex or decimal format)
range: "0..4294967295" "netmask": "string", IPv4 netmask.
"address": "string" IPv4 address.
},
"as-number": "integer" 2-byte/4-byte AS number
range: "1..4294967295"
}
}, "ipv4-next-hop": "string", IPv4 address.
"vrf": "string" VRF name.
}, "ipv6-next-hop": "string", IPv6 address.
"vrf": "string" VRF name.
}
},
"class-name": "string", Name of class-map.
"ecn-red": [ null ], ECN based random early detection "criterion-packet-rate": [ null ], React criterion packet rate.
"criterion-media-stop": [ null ], React criterion media stop.
"criterion-flow-count": [ null ], React criterion flow count. "group-count": "integer", Number of flows to reach before\ntriggering alarm
units: "number of flows"
"discrete": [ null ], Discrete alarm type.
"group-percent": "integer" Percent to reach before triggering alarm
units: "percentage"
},
"severity": "string" Severity of the alarm.
}, "less-than-equal": "string", Less than equal
"range": "string", Range
"greater-than-equal": "string", Greater than equal
"less-than": "string", Less than
"greater-than": "string" Greater than
}, "average": "integer", Trigger averaged over N intervals.
"immediate": [ null ] Immediate trigger.
}
},
"criterion-delay-factor": [ null ], React criterion delay factor.
"descrition": "string", String describing the react statement. "syslog": [ null ], Syslog.
"snmp": [ null ] SNMP.
},
"criterion-mrv": [ null ] React criterion mrv.
}, "unit": "string", Remaining bandwidth units.
"value": "integer" Dhcp client Id.
}, "units": "string", Rate units.
"value": "integer" Dhcp client Id.
}
},
"pbr-drop": [ null ], Policy action PBR drop.
"priority-level": "integer", Priority level.
range: "1..7"
"service-fragment": "string", Policy action service fragment.\nService fragment name "unit": "string", Remaining bandwidth units.
"value": "integer" Dhcp client Id.
}, "Transmit": [ null ], Police action transmit.
"drop": [ null ], Police action drop. "dei": "integer", Match DEI bit.
range: "0..1"
"cos": "integer", Match CoS.
range: "0..7"
"inner-cos": "integer", Match inner CoS.
range: "0..7"
"forward-class": "integer", Sets the forward class.
range: "0..7"
"precedence": "string", Match precedence.
range: "0..7"
"srp-priority": "integer", Sets the spatial reuse protocol priority value of an\noutgoing packet.
range: "0..7"
"df": "integer", Set DF bit.
range: "0..1"
"fr-de": "integer", Match FrameRelay DE bit.
range: "0..1"
"dscp-tunnel": "string", Marks a packet by setting DSCP in the tunnel header.\nThis is specific to ipsec tunnels
"mpls-experimental-top-most": "integer", Sets the experimental value of the MPLS packet top-most\nlabels.
range: "0..7"
"dscp": "string", Match DSCP.
"mpls-experimental-imposition": "integer", Match MPLS experimental imposition label.
range: "0..7"
"qos-group": "integer", Match QoS group.\nShould be value 0..512 or range.
range: "0..512"
"traffic-class": "integer", Match Traffic Class.\nShould be value 0..63 or range.
range: "0..63"
"destination-address": "string", Destination IPv4 address.
"precedence-tunnel": "string", Sets the precedence tunnel value for ipsec.
range: "0..7"
"source-address": "string", Source IPv4 address.
"discard-class": "integer", Match discard class.
range: "0..7"
"dei-imposition": "integer", Set DEI imposition bit.
range: "0..1"
"atm-clp": [ null ] Match ATM CLP bit.
}
}, "units": "string", Rate units.
"value": "integer" Dhcp client Id.
}, "units": "string", Rate units.
"value": "integer" Dhcp client Id.
}, "units": "string", Rate units.
"value": "integer" Dhcp client Id.
}, "Transmit": [ null ], Police action transmit.
"drop": [ null ], Police action drop. "dei": "integer", Match DEI bit.
range: "0..1"
"cos": "integer", Match CoS.
range: "0..7"
"inner-cos": "integer", Match inner CoS.
range: "0..7"
"forward-class": "integer", Sets the forward class.
range: "0..7"
"precedence": "string", Match precedence.
range: "0..7"
"srp-priority": "integer", Sets the spatial reuse protocol priority value of an\noutgoing packet.
range: "0..7"
"df": "integer", Set DF bit.
range: "0..1"
"fr-de": "integer", Match FrameRelay DE bit.
range: "0..1"
"dscp-tunnel": "string", Marks a packet by setting DSCP in the tunnel header.\nThis is specific to ipsec tunnels
"mpls-experimental-top-most": "integer", Sets the experimental value of the MPLS packet top-most\nlabels.
range: "0..7"
"dscp": "string", Match DSCP.
"mpls-experimental-imposition": "integer", Match MPLS experimental imposition label.
range: "0..7"
"qos-group": "integer", Match QoS group.\nShould be value 0..512 or range.
range: "0..512"
"traffic-class": "integer", Match Traffic Class.\nShould be value 0..63 or range.
range: "0..63"
"destination-address": "string", Destination IPv4 address.
"precedence-tunnel": "string", Sets the precedence tunnel value for ipsec.
range: "0..7"
"source-address": "string", Source IPv4 address.
"discard-class": "integer", Match discard class.
range: "0..7"
"dei-imposition": "integer", Set DEI imposition bit.
range: "0..1"
"atm-clp": [ null ] Match ATM CLP bit.
}
}, "units": "string", Rate units.
"value": "integer" Dhcp client Id.
}, "Transmit": [ null ], Police action transmit.
"drop": [ null ], Police action drop. "dei": "integer", Match DEI bit.
range: "0..1"
"cos": "integer", Match CoS.
range: "0..7"
"inner-cos": "integer", Match inner CoS.
range: "0..7"
"forward-class": "integer", Sets the forward class.
range: "0..7"
"precedence": "string", Match precedence.
range: "0..7"
"srp-priority": "integer", Sets the spatial reuse protocol priority value of an\noutgoing packet.
range: "0..7"
"df": "integer", Set DF bit.
range: "0..1"
"fr-de": "integer", Match FrameRelay DE bit.
range: "0..1"
"dscp-tunnel": "string", Marks a packet by setting DSCP in the tunnel header.\nThis is specific to ipsec tunnels
"mpls-experimental-top-most": "integer", Sets the experimental value of the MPLS packet top-most\nlabels.
range: "0..7"
"dscp": "string", Match DSCP.
"mpls-experimental-imposition": "integer", Match MPLS experimental imposition label.
range: "0..7"
"qos-group": "integer", Match QoS group.\nShould be value 0..512 or range.
range: "0..512"
"traffic-class": "integer", Match Traffic Class.\nShould be value 0..63 or range.
range: "0..63"
"destination-address": "string", Destination IPv4 address.
"precedence-tunnel": "string", Sets the precedence tunnel value for ipsec.
range: "0..7"
"source-address": "string", Source IPv4 address.
"discard-class": "integer", Match discard class.
range: "0..7"
"dei-imposition": "integer", Set DEI imposition bit.
range: "0..1"
"atm-clp": [ null ] Match ATM CLP bit.
}
}
}, "subscriberip": [ null ], Subscriber IP
"hostname": [ null ], Hostname
"subscribermac": [ null ], Subscriber Mac
"bngidentifierinterface": [ null ] Bng Identifier Interface
}, "layer3": "integer", Nominal rate specified at the L3 (IP).
units: "bps"
"media": "integer", Nominal data rate of the media flow (ip payload).
range: "1..3000000000"
units: "bps"
"packet": "integer" Nominal IP layer packet rate (in pps).
units: "pps"
}, "count-in-layer3": "integer", Nominal number of media packets in an IP payload.
range: "1..64"
units: "packets"
"size": "integer" Nominal size of the media-packet.
units: "bytes"
}
}, "flow-idle-timeout": "string", The interval after which a flow is removed,\nif there is no activity.\nIf timeout is 0 this flow does not expire. "units": "string", Rate units.
"value": "integer" Dhcp client Id.
range: "1..4294967295"
}, "units": "string", Rate units.
"value": "integer" Dhcp client Id.
range: "1..4294967295"
}
}, "unit": "string", Remaining bandwidth units.
"value": "integer" Dhcp client Id.
},
"http-redirect": "string", Policy action http redirect.\nRedirect to this url. "default": [ null ], Use system default routing table. : { "ipv6-address": "string", IPv6 address.
"ipv4-address": "string", IPv4 address.
"vrf": "string" VRF name.
}
}, "max-flow": "integer", Max simultaneous flows monitored per policy class
range: "0..4096"
"interval-duration": "integer", Monitored interval duration.
units: "seconds"
"timeout": "integer", Declare a flow dead if no packets received in\nso much time
units: "seconds"
"history": "integer" Keep stats/metrics on box for so many intervals.
},
"class-type": "enumeration", Type of class-map.
Options:
qos
traffic
subscriber-control "policy-name": "string", Name of service-policy.
"type": "string" Type of class-map.
}, "unit": "string", Remaining bandwidth units.
"value": "integer" Dhcp client Id.
},
"decap-gre": [ null ], Policy action DECAP GRE. {
"cos": "string", Match CoS.
range: "0..7"
"threshold-max-value": "integer", Maximum RED threshold value.
"precedence": "string", Match precedence.
range: "0..7"
"threshold-min-value": "integer", Minimum RED threshold value.
"threshold-max-units": "string", Maximum RED threshold units.
"dscp": "string", Match DSCP.
"dei": "integer", Match DEI bit.
range: "0..1"
"threshold-min-units": "string", Minimum RED threshold units.
"ecn": [ null ], ECN based WRED.
"discard-class": "string", Match discard class.
range: "0..7"
"mpls-exp": "string" MPLS Experimental value based WRED.
range: "0..7"
}
]
}
],
"type": "enumeration", Type of class-map.
Options:
qos
pbr
traffic
subscriber-control
accounting
redirect
flow-monitor
"description": "string", Description for this policy-map.
"name": "string" Domain name or regular expression.
}
]
}, { {
"class-map-mode-match-any": [ null ], Match all match criteria
"name": "string", Domain name or regular expression. "service-name-regex": "string", Match servicve name regular expression.
"protocol": "string", Match protocol.
"vpls-broadcast": [ null ], Match VPLS Broadcast
"precedence": "string", Match precedence.
range: "0..7"
"packet-length": "string", Match packet length.\nShould be value 0..65535 or range.
"fr-de": "integer", Match FrameRelay DE bit.
range: "0..1"
"circuit-id-regex": "string", Match Circuit id regex.
"traffic-class": "string", Match Traffic Class.\nShould be value 0..63 or range.
"ipv6-packet-length": "string", Match IPv6 packet length.\nShould be value 0..65535 or range.
"icmpv6-code": "string", Match IPv6 ICMP code.\nShould be value 0..255 or range.
"timer": "string", Match timer.
"vpls-multicast": [ null ], Match VPLS Multicast
"service-name": "string", Match servicve name.
"fragment-type": "string", Match fragment type for a packet.
"flow-tag": "string", Match flow-tag. Should be value 1..63 or range.
"ipv4-packet-length": "string", Match IPv4 packet length.\nShould be value 0..65535 or range. {
"netmask": "string", IPv4 netmask.
"address": "string" IPv4 address.
}
], {
"prefix-length": "integer", IPv6 prefix length.
range: "0..128"
"address": "string" IPv4 address.
}
],
"authen-status": "string", Match authentication status.
"ipv4-precedence": "string", Match IPv4 precedence.
range: "0..7"
"ipv4-dscp": "string", Match IPv4 DSCP.
"tcp-flag": "integer", Match TCP flags.
range: "0..4095"
"ethertype": "string", Match Ethertype.
"mpls-experimental-topmost": "string", Match MPLS experimental topmost label.
range: "0..7"
"ethernet-services-acl": "string", Match Ethernet Services {
"flag": "string", Dhcp client id Ascii/Hex
"value": "string" Dhcp client Id.
}
],
"ipv4-acl": "string", Match IPv4 ACL.
"icmpv6-type": "string", Match IPv6 ICMP type.\nShould be value 0..255 or range.
"vpls-known": [ null ], Match VPLS Known
"destination-port": "string", Match destination port.\nShould be value 0..65535 or range. {
"flag": "string", Dhcp client id Ascii/Hex
"value": "string" Dhcp client Id.
}
],
"inner-cos": "string", Match inner CoS.
range: "0..7"
"frame-relay-dlci": "string", Match frame-relay DLCI value.\nShould be value 16..1007 or range.
"vpls-unknown": [ null ], Match VPLS Unknown
"vlan": "string", Match VLAN ID.
"user-name": "string", Match user name.
"dscp": "string", Match DSCP.
"mpls-experimental-imposition": "string", Match MPLS experimental imposition label.
range: "0..7"
"qos-group": "string", Match QoS group.\nShould be value 0..512 or range.
"source-mac": "string", Match source MAC address.
"circuit-id": "string", Match Circuit ID.
"ipv6-acl": "string", Match IPv6 ACL.
"source-port": "string", Match source port.\nShould be value 0..65535 or range.
"user-name-regex": "string", Match user name regular expression. {
"prefix-length": "integer", IPv6 prefix length.
range: "0..128"
"address": "string" IPv4 address.
}
],
"inner-vlan": "string", Match inner VLAN ID. {
"flow-tag": "integer" Match flow-tag. Should be value 1..63 or range.
range: "1..63"
}
],
"cos": "string", Match CoS.
range: "0..7"
"mpls-disposition-ipv6-access-list": "string", Match MPLS Label Disposition IPv6 access list.
"destination-mac": "string", Match destination MAC address.
"dei-inner": "integer", Match DEI INNER bit.
range: "0..1"
"remote-id-regex": "string", Match remote id regex.
"timer-regex": "string", Match timer regular expression. {
"netmask": "string", IPv4 netmask.
"address": "string" IPv4 address.
}
], {
"regex": "string", Domain name or regular expression.
"format": "string" Domain-format name.
}
],
"ipv6-dscp": "string", Match IPv6 DSCP.
"dei": "integer", Match DEI bit.
range: "0..1"
"icmpv4-code": "string", Match IPv4 ICMP code.\nShould be value 0..255 or range. {
"name": "string", Domain name or regular expression.
"format": "string" Domain-format name.
}
],
"remote-id": "string", Match remote ID.
"icmpv4-type": "string", Match IPv4 ICMP type.\nShould be value 0..255 or range.
"discard-class": "string", Match discard class.
range: "0..7"
"mpls-disposition-ipv4-access-list": "string", Match MPLS Label Disposition IPv4 access list.
"vpls-control": [ null ], Match VPLS control
"ipv6-precedence": "string" Match IPv6 precedence.
range: "0..7"
},
"type": "enumeration", Type of class-map.
Options:
qos
traffic
control
"class-map-mode-match-all": [ null ], Match any match criteria. {
"service-name-regex": "string", Match servicve name regular expression.
"protocol": "string", Match protocol.
"vpls-broadcast": [ null ], Match VPLS Broadcast
"precedence": "string", Match precedence.
range: "0..7"
"packet-length": "string", Match packet length.\nShould be value 0..65535 or range.
"fr-de": "integer", Match FrameRelay DE bit.
range: "0..1"
"cac-admit": [ null ], Match CAC admitted.
"circuit-id-regex": "string", Match Circuit id regex.
"atm-clp": "integer", Match ATM CLP bit.
range: "0..1"
"traffic-class": "string", Match Traffic Class.\nShould be value 0..63 or range.
"ipv6-packet-length": "string", Match IPv6 packet length.\nShould be value 0..65535 or range.
"icmpv6-code": "string", Match IPv6 ICMP code.\nShould be value 0..255 or range.
"timer": "string", Match timer.
"vpls-multicast": [ null ], Match VPLS Multicast
"service-name": "string", Match servicve name.
"fragment-type": "string", Match fragment type for a packet.
"flow-tag": "string", Match flow-tag. Should be value 1..63 or range.
"ipv4-packet-length": "string", Match IPv4 packet length.\nShould be value 0..65535 or range. {
"netmask": "string", IPv4 netmask.
"address": "string" IPv4 address.
}
], {
"prefix-length": "integer", IPv6 prefix length.
range: "0..128"
"address": "string" IPv4 address.
}
],
"authen-status": "string", Match authentication status.
"ipv4-precedence": "string", Match IPv4 precedence.
range: "0..7"
"ipv4-dscp": "string", Match IPv4 DSCP.
"tcp-flag": "integer", Match TCP flags.
range: "0..4095"
"ethertype": "string", Match Ethertype.
"mpls-experimental-topmost": "string", Match MPLS experimental topmost label.
range: "0..7"
"ethernet-services-acl": "string", Match Ethernet Services {
"flag": "string", Dhcp client id Ascii/Hex
"value": "string" Dhcp client Id.
}
],
"ipv4-acl": "string", Match IPv4 ACL.
"cac-unadmit": [ null ], Match CAC unadmitted.
"icmpv6-type": "string", Match IPv6 ICMP type.\nShould be value 0..255 or range.
"vpls-known": [ null ], Match VPLS Known
"destination-port": "string", Match destination port.\nShould be value 0..65535 or range. {
"flag": "string", Dhcp client id Ascii/Hex
"value": "string" Dhcp client Id.
}
],
"inner-cos": "string", Match inner CoS.
range: "0..7"
"frame-relay-dlci": "string", Match frame-relay DLCI value.\nShould be value 16..1007 or range.
"vpls-unknown": [ null ], Match VPLS Unknown
"vlan": "string", Match VLAN ID.
"user-name": "string", Match user name.
"dscp": "string", Match DSCP.
"mpls-experimental-imposition": "string", Match MPLS experimental imposition label.
range: "0..7"
"qos-group": "string", Match QoS group.\nShould be value 0..512 or range.
"source-mac": "string", Match source MAC address.
"circuit-id": "string", Match Circuit ID.
"ipv6-acl": "string", Match IPv6 ACL.
"atm-oam": [ null ], Match ATM OAM.
"source-port": "string", Match source port.\nShould be value 0..65535 or range.
"user-name-regex": "string", Match user name regular expression. {
"prefix-length": "integer", IPv6 prefix length.
range: "0..128"
"address": "string" IPv4 address.
}
],
"inner-vlan": "string", Match inner VLAN ID.
"cos": "string", Match CoS.
range: "0..7"
"mpls-disposition-ipv6-access-list": "string", Match MPLS Label Disposition IPv6 access list.
"destination-mac": "string", Match destination MAC address.
"dei-inner": "integer", Match DEI INNER bit.
range: "0..1"
"remote-id-regex": "string", Match remote id regex.
"timer-regex": "string", Match timer regular expression. {
"netmask": "string", IPv4 netmask.
"address": "string" IPv4 address.
}
], "flow-key": "string", Configure the flow-key parameters. {
"idle-timeout": "string" Maximum time of inactivity for a flow.
}
]
}, {
"regex": "string", Domain name or regular expression.
"format": "string" Domain-format name.
}
],
"ipv6-dscp": "string", Match IPv6 DSCP.
"dei": "integer", Match DEI bit.
range: "0..1"
"icmpv4-code": "string", Match IPv4 ICMP code.\nShould be value 0..255 or range. {
"name": "string", Domain name or regular expression.
"format": "string" Domain-format name.
}
],
"remote-id": "string", Match remote ID.
"icmpv4-type": "string", Match IPv4 ICMP type.\nShould be value 0..255 or range.
"discard-class": "string", Match discard class.
range: "0..7"
"mpls-disposition-ipv4-access-list": "string", Match MPLS Label Disposition IPv4 access list.
"vpls-control": [ null ], Match VPLS control
"ipv6-precedence": "string" Match IPv6 precedence.
range: "0..7"
}
],
"description": "string" Description for this policy-map.
}
]
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
POLICY-MANAGER - Delete
Delete operation of resource: policy-manager
Successful operation
Internal Error
Response Content-Types: application/json
POLICY-MANAGER - Retrieve
Retrieve operation of resource: policy-manager
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { {
"event-mode-match-all": [ null ], Execute all the matched classes.
"event-type": "enumeration", Event type.
Options:
account-logoff
account-logon
authentication-failure
authentication-no-response
authorization-failure
authorization-no-response
credit-exhausted
exception
idle-timeout
quota-depleted
service-start
service-stop
session-activate
session-start
session-stop
timer-expiry { { "aaa-list": "string", Name of the AAA method list.
"password": "string", Specify a password to be used for AAA\nrequest.
"identifier": "enumeration", Specify an Authorize format name.
Options:
circuit-id
dhcp-client-id
remote-id
source-address-ipv4
source-address-ipv6
source-address-mac
username
"format": "string" Domain-format name.
}, "aaa-list": "string", Name of the AAA method list.
"name": "string" Domain name or regular expression.
}, "aaa-list": "string" Name of the AAA method list.
},
"disconnect": [ null ], Disconnect session.
"monitor": [ null ], Monitor session.
"action-sequence-number": "integer", Sequence number for this action.
range: "1..65535" "timer-value": "integer", Timer value in minutes.
units: "minutes"
"timer-name": "string" Name of the timer.
}, "timer-name": "string" Name of the timer.
}, "aaa-list": "string", Name of the AAA method list.
"name": "string" Domain name or regular expression.
}
}
],
"class-execution-strategy": "enumeration", Class execution strategy.
Options:
do-all
do-until-failure
do-until-success
"class-name": "string", Name of class-map.
"class-type": "enumeration" Type of class-map.
Options:
qos
traffic
subscriber-control
}
],
"event-mode-match-first": [ null ] Execute only the first matched class.
}
], { "unit": "string", Remaining bandwidth units.
"value": "integer" Dhcp client Id.
}, "unit": "string", Remaining bandwidth units.
"value": "integer" Dhcp client Id.
},
"pfc-pause-set": [ null ], Pfc Pause set value. "unit": "string", Remaining bandwidth units.
"value": "integer" Dhcp client Id.
}
}, "index": "integer", ASN2:index 2/4 byte (hex or decimal format)
range: "1..255"
"path-id": "integer", Service function path id.
range: "1..16777215"
"metadata": "string" Service function path metadata name.
},
"default-red": [ null ], Default random early detection
"pbr-transmit": [ null ], Policy action PBR transmit.
"fragment": "string", Policy action fragment. Fragment name "dei": "integer", Match DEI bit.
range: "0..1"
"cos": "integer", Match CoS.
range: "0..7"
"inner-cos": "integer", Match inner CoS.
range: "0..7"
"forward-class": "integer", Sets the forward class.
range: "0..7"
"precedence": "string", Match precedence.
range: "0..7"
"srp-priority": "integer", Sets the spatial reuse protocol priority value of an\noutgoing packet.
range: "0..7"
"df": "integer", Set DF bit.
range: "0..1"
"fr-de": "integer", Match FrameRelay DE bit.
range: "0..1"
"dscp-tunnel": "string", Marks a packet by setting DSCP in the tunnel header.\nThis is specific to ipsec tunnels
"mpls-experimental-top-most": "integer", Sets the experimental value of the MPLS packet top-most\nlabels.
range: "0..7"
"dscp": "string", Match DSCP.
"mpls-experimental-imposition": "integer", Match MPLS experimental imposition label.
range: "0..7"
"qos-group": "integer", Match QoS group.\nShould be value 0..512 or range.
range: "0..512"
"traffic-class": "integer", Match Traffic Class.\nShould be value 0..63 or range.
range: "0..63"
"destination-address": "string", Destination IPv4 address.
"precedence-tunnel": "string", Sets the precedence tunnel value for ipsec.
range: "0..7"
"source-address": "string", Source IPv4 address.
"discard-class": "integer", Match discard class.
range: "0..7"
"dei-imposition": "integer", Set DEI imposition bit.
range: "0..1"
"atm-clp": [ null ] Match ATM CLP bit.
}, "index": "integer", ASN2:index 2/4 byte (hex or decimal format)
range: "0..4294967295" "netmask": "string", IPv4 netmask.
"address": "string" IPv4 address.
},
"as-number": "integer" 2-byte/4-byte AS number
range: "1..4294967295"
}
}, "ipv4-next-hop": "string", IPv4 address.
"vrf": "string" VRF name.
}, "ipv6-next-hop": "string", IPv6 address.
"vrf": "string" VRF name.
}
},
"class-name": "string", Name of class-map.
"ecn-red": [ null ], ECN based random early detection "criterion-packet-rate": [ null ], React criterion packet rate.
"criterion-media-stop": [ null ], React criterion media stop.
"criterion-flow-count": [ null ], React criterion flow count. "group-count": "integer", Number of flows to reach before\ntriggering alarm
units: "number of flows"
"discrete": [ null ], Discrete alarm type.
"group-percent": "integer" Percent to reach before triggering alarm
units: "percentage"
},
"severity": "string" Severity of the alarm.
}, "less-than-equal": "string", Less than equal
"range": "string", Range
"greater-than-equal": "string", Greater than equal
"less-than": "string", Less than
"greater-than": "string" Greater than
}, "average": "integer", Trigger averaged over N intervals.
"immediate": [ null ] Immediate trigger.
}
},
"criterion-delay-factor": [ null ], React criterion delay factor.
"descrition": "string", String describing the react statement. "syslog": [ null ], Syslog.
"snmp": [ null ] SNMP.
},
"criterion-mrv": [ null ] React criterion mrv.
}, "unit": "string", Remaining bandwidth units.
"value": "integer" Dhcp client Id.
}, "units": "string", Rate units.
"value": "integer" Dhcp client Id.
}
},
"pbr-drop": [ null ], Policy action PBR drop.
"priority-level": "integer", Priority level.
range: "1..7"
"service-fragment": "string", Policy action service fragment.\nService fragment name "unit": "string", Remaining bandwidth units.
"value": "integer" Dhcp client Id.
}, "Transmit": [ null ], Police action transmit.
"drop": [ null ], Police action drop. "dei": "integer", Match DEI bit.
range: "0..1"
"cos": "integer", Match CoS.
range: "0..7"
"inner-cos": "integer", Match inner CoS.
range: "0..7"
"forward-class": "integer", Sets the forward class.
range: "0..7"
"precedence": "string", Match precedence.
range: "0..7"
"srp-priority": "integer", Sets the spatial reuse protocol priority value of an\noutgoing packet.
range: "0..7"
"df": "integer", Set DF bit.
range: "0..1"
"fr-de": "integer", Match FrameRelay DE bit.
range: "0..1"
"dscp-tunnel": "string", Marks a packet by setting DSCP in the tunnel header.\nThis is specific to ipsec tunnels
"mpls-experimental-top-most": "integer", Sets the experimental value of the MPLS packet top-most\nlabels.
range: "0..7"
"dscp": "string", Match DSCP.
"mpls-experimental-imposition": "integer", Match MPLS experimental imposition label.
range: "0..7"
"qos-group": "integer", Match QoS group.\nShould be value 0..512 or range.
range: "0..512"
"traffic-class": "integer", Match Traffic Class.\nShould be value 0..63 or range.
range: "0..63"
"destination-address": "string", Destination IPv4 address.
"precedence-tunnel": "string", Sets the precedence tunnel value for ipsec.
range: "0..7"
"source-address": "string", Source IPv4 address.
"discard-class": "integer", Match discard class.
range: "0..7"
"dei-imposition": "integer", Set DEI imposition bit.
range: "0..1"
"atm-clp": [ null ] Match ATM CLP bit.
}
}, "units": "string", Rate units.
"value": "integer" Dhcp client Id.
}, "units": "string", Rate units.
"value": "integer" Dhcp client Id.
}, "units": "string", Rate units.
"value": "integer" Dhcp client Id.
}, "Transmit": [ null ], Police action transmit.
"drop": [ null ], Police action drop. "dei": "integer", Match DEI bit.
range: "0..1"
"cos": "integer", Match CoS.
range: "0..7"
"inner-cos": "integer", Match inner CoS.
range: "0..7"
"forward-class": "integer", Sets the forward class.
range: "0..7"
"precedence": "string", Match precedence.
range: "0..7"
"srp-priority": "integer", Sets the spatial reuse protocol priority value of an\noutgoing packet.
range: "0..7"
"df": "integer", Set DF bit.
range: "0..1"
"fr-de": "integer", Match FrameRelay DE bit.
range: "0..1"
"dscp-tunnel": "string", Marks a packet by setting DSCP in the tunnel header.\nThis is specific to ipsec tunnels
"mpls-experimental-top-most": "integer", Sets the experimental value of the MPLS packet top-most\nlabels.
range: "0..7"
"dscp": "string", Match DSCP.
"mpls-experimental-imposition": "integer", Match MPLS experimental imposition label.
range: "0..7"
"qos-group": "integer", Match QoS group.\nShould be value 0..512 or range.
range: "0..512"
"traffic-class": "integer", Match Traffic Class.\nShould be value 0..63 or range.
range: "0..63"
"destination-address": "string", Destination IPv4 address.
"precedence-tunnel": "string", Sets the precedence tunnel value for ipsec.
range: "0..7"
"source-address": "string", Source IPv4 address.
"discard-class": "integer", Match discard class.
range: "0..7"
"dei-imposition": "integer", Set DEI imposition bit.
range: "0..1"
"atm-clp": [ null ] Match ATM CLP bit.
}
}, "units": "string", Rate units.
"value": "integer" Dhcp client Id.
}, "Transmit": [ null ], Police action transmit.
"drop": [ null ], Police action drop. "dei": "integer", Match DEI bit.
range: "0..1"
"cos": "integer", Match CoS.
range: "0..7"
"inner-cos": "integer", Match inner CoS.
range: "0..7"
"forward-class": "integer", Sets the forward class.
range: "0..7"
"precedence": "string", Match precedence.
range: "0..7"
"srp-priority": "integer", Sets the spatial reuse protocol priority value of an\noutgoing packet.
range: "0..7"
"df": "integer", Set DF bit.
range: "0..1"
"fr-de": "integer", Match FrameRelay DE bit.
range: "0..1"
"dscp-tunnel": "string", Marks a packet by setting DSCP in the tunnel header.\nThis is specific to ipsec tunnels
"mpls-experimental-top-most": "integer", Sets the experimental value of the MPLS packet top-most\nlabels.
range: "0..7"
"dscp": "string", Match DSCP.
"mpls-experimental-imposition": "integer", Match MPLS experimental imposition label.
range: "0..7"
"qos-group": "integer", Match QoS group.\nShould be value 0..512 or range.
range: "0..512"
"traffic-class": "integer", Match Traffic Class.\nShould be value 0..63 or range.
range: "0..63"
"destination-address": "string", Destination IPv4 address.
"precedence-tunnel": "string", Sets the precedence tunnel value for ipsec.
range: "0..7"
"source-address": "string", Source IPv4 address.
"discard-class": "integer", Match discard class.
range: "0..7"
"dei-imposition": "integer", Set DEI imposition bit.
range: "0..1"
"atm-clp": [ null ] Match ATM CLP bit.
}
}
}, "subscriberip": [ null ], Subscriber IP
"hostname": [ null ], Hostname
"subscribermac": [ null ], Subscriber Mac
"bngidentifierinterface": [ null ] Bng Identifier Interface
}, "layer3": "integer", Nominal rate specified at the L3 (IP).
units: "bps"
"media": "integer", Nominal data rate of the media flow (ip payload).
range: "1..3000000000"
units: "bps"
"packet": "integer" Nominal IP layer packet rate (in pps).
units: "pps"
}, "count-in-layer3": "integer", Nominal number of media packets in an IP payload.
range: "1..64"
units: "packets"
"size": "integer" Nominal size of the media-packet.
units: "bytes"
}
}, "flow-idle-timeout": "string", The interval after which a flow is removed,\nif there is no activity.\nIf timeout is 0 this flow does not expire. "units": "string", Rate units.
"value": "integer" Dhcp client Id.
range: "1..4294967295"
}, "units": "string", Rate units.
"value": "integer" Dhcp client Id.
range: "1..4294967295"
}
}, "unit": "string", Remaining bandwidth units.
"value": "integer" Dhcp client Id.
},
"http-redirect": "string", Policy action http redirect.\nRedirect to this url. "default": [ null ], Use system default routing table. : { "ipv6-address": "string", IPv6 address.
"ipv4-address": "string", IPv4 address.
"vrf": "string" VRF name.
}
}, "max-flow": "integer", Max simultaneous flows monitored per policy class
range: "0..4096"
"interval-duration": "integer", Monitored interval duration.
units: "seconds"
"timeout": "integer", Declare a flow dead if no packets received in\nso much time
units: "seconds"
"history": "integer" Keep stats/metrics on box for so many intervals.
},
"class-type": "enumeration", Type of class-map.
Options:
qos
traffic
subscriber-control "policy-name": "string", Name of service-policy.
"type": "string" Type of class-map.
}, "unit": "string", Remaining bandwidth units.
"value": "integer" Dhcp client Id.
},
"decap-gre": [ null ], Policy action DECAP GRE. {
"cos": "string", Match CoS.
range: "0..7"
"threshold-max-value": "integer", Maximum RED threshold value.
"precedence": "string", Match precedence.
range: "0..7"
"threshold-min-value": "integer", Minimum RED threshold value.
"threshold-max-units": "string", Maximum RED threshold units.
"dscp": "string", Match DSCP.
"dei": "integer", Match DEI bit.
range: "0..1"
"threshold-min-units": "string", Minimum RED threshold units.
"ecn": [ null ], ECN based WRED.
"discard-class": "string", Match discard class.
range: "0..7"
"mpls-exp": "string" MPLS Experimental value based WRED.
range: "0..7"
}
]
}
],
"type": "enumeration", Type of class-map.
Options:
qos
pbr
traffic
subscriber-control
accounting
redirect
flow-monitor
"description": "string", Description for this policy-map.
"name": "string" Domain name or regular expression.
}
]
}, { {
"class-map-mode-match-any": [ null ], Match all match criteria
"name": "string", Domain name or regular expression. "service-name-regex": "string", Match servicve name regular expression.
"protocol": "string", Match protocol.
"vpls-broadcast": [ null ], Match VPLS Broadcast
"precedence": "string", Match precedence.
range: "0..7"
"packet-length": "string", Match packet length.\nShould be value 0..65535 or range.
"fr-de": "integer", Match FrameRelay DE bit.
range: "0..1"
"circuit-id-regex": "string", Match Circuit id regex.
"traffic-class": "string", Match Traffic Class.\nShould be value 0..63 or range.
"ipv6-packet-length": "string", Match IPv6 packet length.\nShould be value 0..65535 or range.
"icmpv6-code": "string", Match IPv6 ICMP code.\nShould be value 0..255 or range.
"timer": "string", Match timer.
"vpls-multicast": [ null ], Match VPLS Multicast
"service-name": "string", Match servicve name.
"fragment-type": "string", Match fragment type for a packet.
"flow-tag": "string", Match flow-tag. Should be value 1..63 or range.
"ipv4-packet-length": "string", Match IPv4 packet length.\nShould be value 0..65535 or range. {
"netmask": "string", IPv4 netmask.
"address": "string" IPv4 address.
}
], {
"prefix-length": "integer", IPv6 prefix length.
range: "0..128"
"address": "string" IPv4 address.
}
],
"authen-status": "string", Match authentication status.
"ipv4-precedence": "string", Match IPv4 precedence.
range: "0..7"
"ipv4-dscp": "string", Match IPv4 DSCP.
"tcp-flag": "integer", Match TCP flags.
range: "0..4095"
"ethertype": "string", Match Ethertype.
"mpls-experimental-topmost": "string", Match MPLS experimental topmost label.
range: "0..7"
"ethernet-services-acl": "string", Match Ethernet Services {
"flag": "string", Dhcp client id Ascii/Hex
"value": "string" Dhcp client Id.
}
],
"ipv4-acl": "string", Match IPv4 ACL.
"icmpv6-type": "string", Match IPv6 ICMP type.\nShould be value 0..255 or range.
"vpls-known": [ null ], Match VPLS Known
"destination-port": "string", Match destination port.\nShould be value 0..65535 or range. {
"flag": "string", Dhcp client id Ascii/Hex
"value": "string" Dhcp client Id.
}
],
"inner-cos": "string", Match inner CoS.
range: "0..7"
"frame-relay-dlci": "string", Match frame-relay DLCI value.\nShould be value 16..1007 or range.
"vpls-unknown": [ null ], Match VPLS Unknown
"vlan": "string", Match VLAN ID.
"user-name": "string", Match user name.
"dscp": "string", Match DSCP.
"mpls-experimental-imposition": "string", Match MPLS experimental imposition label.
range: "0..7"
"qos-group": "string", Match QoS group.\nShould be value 0..512 or range.
"source-mac": "string", Match source MAC address.
"circuit-id": "string", Match Circuit ID.
"ipv6-acl": "string", Match IPv6 ACL.
"source-port": "string", Match source port.\nShould be value 0..65535 or range.
"user-name-regex": "string", Match user name regular expression. {
"prefix-length": "integer", IPv6 prefix length.
range: "0..128"
"address": "string" IPv4 address.
}
],
"inner-vlan": "string", Match inner VLAN ID. {
"flow-tag": "integer" Match flow-tag. Should be value 1..63 or range.
range: "1..63"
}
],
"cos": "string", Match CoS.
range: "0..7"
"mpls-disposition-ipv6-access-list": "string", Match MPLS Label Disposition IPv6 access list.
"destination-mac": "string", Match destination MAC address.
"dei-inner": "integer", Match DEI INNER bit.
range: "0..1"
"remote-id-regex": "string", Match remote id regex.
"timer-regex": "string", Match timer regular expression. {
"netmask": "string", IPv4 netmask.
"address": "string" IPv4 address.
}
], {
"regex": "string", Domain name or regular expression.
"format": "string" Domain-format name.
}
],
"ipv6-dscp": "string", Match IPv6 DSCP.
"dei": "integer", Match DEI bit.
range: "0..1"
"icmpv4-code": "string", Match IPv4 ICMP code.\nShould be value 0..255 or range. {
"name": "string", Domain name or regular expression.
"format": "string" Domain-format name.
}
],
"remote-id": "string", Match remote ID.
"icmpv4-type": "string", Match IPv4 ICMP type.\nShould be value 0..255 or range.
"discard-class": "string", Match discard class.
range: "0..7"
"mpls-disposition-ipv4-access-list": "string", Match MPLS Label Disposition IPv4 access list.
"vpls-control": [ null ], Match VPLS control
"ipv6-precedence": "string" Match IPv6 precedence.
range: "0..7"
},
"type": "enumeration", Type of class-map.
Options:
qos
traffic
control
"class-map-mode-match-all": [ null ], Match any match criteria. {
"service-name-regex": "string", Match servicve name regular expression.
"protocol": "string", Match protocol.
"vpls-broadcast": [ null ], Match VPLS Broadcast
"precedence": "string", Match precedence.
range: "0..7"
"packet-length": "string", Match packet length.\nShould be value 0..65535 or range.
"fr-de": "integer", Match FrameRelay DE bit.
range: "0..1"
"cac-admit": [ null ], Match CAC admitted.
"circuit-id-regex": "string", Match Circuit id regex.
"atm-clp": "integer", Match ATM CLP bit.
range: "0..1"
"traffic-class": "string", Match Traffic Class.\nShould be value 0..63 or range.
"ipv6-packet-length": "string", Match IPv6 packet length.\nShould be value 0..65535 or range.
"icmpv6-code": "string", Match IPv6 ICMP code.\nShould be value 0..255 or range.
"timer": "string", Match timer.
"vpls-multicast": [ null ], Match VPLS Multicast
"service-name": "string", Match servicve name.
"fragment-type": "string", Match fragment type for a packet.
"flow-tag": "string", Match flow-tag. Should be value 1..63 or range.
"ipv4-packet-length": "string", Match IPv4 packet length.\nShould be value 0..65535 or range. {
"netmask": "string", IPv4 netmask.
"address": "string" IPv4 address.
}
], {
"prefix-length": "integer", IPv6 prefix length.
range: "0..128"
"address": "string" IPv4 address.
}
],
"authen-status": "string", Match authentication status.
"ipv4-precedence": "string", Match IPv4 precedence.
range: "0..7"
"ipv4-dscp": "string", Match IPv4 DSCP.
"tcp-flag": "integer", Match TCP flags.
range: "0..4095"
"ethertype": "string", Match Ethertype.
"mpls-experimental-topmost": "string", Match MPLS experimental topmost label.
range: "0..7"
"ethernet-services-acl": "string", Match Ethernet Services {
"flag": "string", Dhcp client id Ascii/Hex
"value": "string" Dhcp client Id.
}
],
"ipv4-acl": "string", Match IPv4 ACL.
"cac-unadmit": [ null ], Match CAC unadmitted.
"icmpv6-type": "string", Match IPv6 ICMP type.\nShould be value 0..255 or range.
"vpls-known": [ null ], Match VPLS Known
"destination-port": "string", Match destination port.\nShould be value 0..65535 or range. {
"flag": "string", Dhcp client id Ascii/Hex
"value": "string" Dhcp client Id.
}
],
"inner-cos": "string", Match inner CoS.
range: "0..7"
"frame-relay-dlci": "string", Match frame-relay DLCI value.\nShould be value 16..1007 or range.
"vpls-unknown": [ null ], Match VPLS Unknown
"vlan": "string", Match VLAN ID.
"user-name": "string", Match user name.
"dscp": "string", Match DSCP.
"mpls-experimental-imposition": "string", Match MPLS experimental imposition label.
range: "0..7"
"qos-group": "string", Match QoS group.\nShould be value 0..512 or range.
"source-mac": "string", Match source MAC address.
"circuit-id": "string", Match Circuit ID.
"ipv6-acl": "string", Match IPv6 ACL.
"atm-oam": [ null ], Match ATM OAM.
"source-port": "string", Match source port.\nShould be value 0..65535 or range.
"user-name-regex": "string", Match user name regular expression. {
"prefix-length": "integer", IPv6 prefix length.
range: "0..128"
"address": "string" IPv4 address.
}
],
"inner-vlan": "string", Match inner VLAN ID.
"cos": "string", Match CoS.
range: "0..7"
"mpls-disposition-ipv6-access-list": "string", Match MPLS Label Disposition IPv6 access list.
"destination-mac": "string", Match destination MAC address.
"dei-inner": "integer", Match DEI INNER bit.
range: "0..1"
"remote-id-regex": "string", Match remote id regex.
"timer-regex": "string", Match timer regular expression. {
"netmask": "string", IPv4 netmask.
"address": "string" IPv4 address.
}
], "flow-key": "string", Configure the flow-key parameters. {
"idle-timeout": "string" Maximum time of inactivity for a flow.
}
]
}, {
"regex": "string", Domain name or regular expression.
"format": "string" Domain-format name.
}
],
"ipv6-dscp": "string", Match IPv6 DSCP.
"dei": "integer", Match DEI bit.
range: "0..1"
"icmpv4-code": "string", Match IPv4 ICMP code.\nShould be value 0..255 or range. {
"name": "string", Domain name or regular expression.
"format": "string" Domain-format name.
}
],
"remote-id": "string", Match remote ID.
"icmpv4-type": "string", Match IPv4 ICMP type.\nShould be value 0..255 or range.
"discard-class": "string", Match discard class.
range: "0..7"
"mpls-disposition-ipv4-access-list": "string", Match MPLS Label Disposition IPv4 access list.
"vpls-control": [ null ], Match VPLS control
"ipv6-precedence": "string" Match IPv6 precedence.
range: "0..7"
}
],
"description": "string" Description for this policy-map.
}
]
}
]
}
}
CLASS-MAPS - Update
Update operation of resource: class-maps
class-mapsbody object
Request Content-Types: application/json
Request Example
{ {
"class-map-mode-match-any": [ null ], Match all match criteria
"name": "string", Domain name or regular expression. "service-name-regex": "string", Match servicve name regular expression.
"protocol": "string", Match protocol.
"vpls-broadcast": [ null ], Match VPLS Broadcast
"precedence": "string", Match precedence.
range: "0..7"
"packet-length": "string", Match packet length.\nShould be value 0..65535 or range.
"fr-de": "integer", Match FrameRelay DE bit.
range: "0..1"
"circuit-id-regex": "string", Match Circuit id regex.
"traffic-class": "string", Match Traffic Class.\nShould be value 0..63 or range.
"ipv6-packet-length": "string", Match IPv6 packet length.\nShould be value 0..65535 or range.
"icmpv6-code": "string", Match IPv6 ICMP code.\nShould be value 0..255 or range.
"timer": "string", Match timer.
"vpls-multicast": [ null ], Match VPLS Multicast
"service-name": "string", Match servicve name.
"fragment-type": "string", Match fragment type for a packet.
"flow-tag": "string", Match flow-tag. Should be value 1..63 or range.
"ipv4-packet-length": "string", Match IPv4 packet length.\nShould be value 0..65535 or range. {
"netmask": "string", IPv4 netmask.
"address": "string" IPv4 address.
}
], {
"prefix-length": "integer", IPv6 prefix length.
range: "0..128"
"address": "string" IPv4 address.
}
],
"authen-status": "string", Match authentication status.
"ipv4-precedence": "string", Match IPv4 precedence.
range: "0..7"
"ipv4-dscp": "string", Match IPv4 DSCP.
"tcp-flag": "integer", Match TCP flags.
range: "0..4095"
"ethertype": "string", Match Ethertype.
"mpls-experimental-topmost": "string", Match MPLS experimental topmost label.
range: "0..7"
"ethernet-services-acl": "string", Match Ethernet Services {
"flag": "string", Dhcp client id Ascii/Hex
"value": "string" Dhcp client Id.
}
],
"ipv4-acl": "string", Match IPv4 ACL.
"icmpv6-type": "string", Match IPv6 ICMP type.\nShould be value 0..255 or range.
"vpls-known": [ null ], Match VPLS Known
"destination-port": "string", Match destination port.\nShould be value 0..65535 or range. {
"flag": "string", Dhcp client id Ascii/Hex
"value": "string" Dhcp client Id.
}
],
"inner-cos": "string", Match inner CoS.
range: "0..7"
"frame-relay-dlci": "string", Match frame-relay DLCI value.\nShould be value 16..1007 or range.
"vpls-unknown": [ null ], Match VPLS Unknown
"vlan": "string", Match VLAN ID.
"user-name": "string", Match user name.
"dscp": "string", Match DSCP.
"mpls-experimental-imposition": "string", Match MPLS experimental imposition label.
range: "0..7"
"qos-group": "string", Match QoS group.\nShould be value 0..512 or range.
"source-mac": "string", Match source MAC address.
"circuit-id": "string", Match Circuit ID.
"ipv6-acl": "string", Match IPv6 ACL.
"source-port": "string", Match source port.\nShould be value 0..65535 or range.
"user-name-regex": "string", Match user name regular expression. {
"prefix-length": "integer", IPv6 prefix length.
range: "0..128"
"address": "string" IPv4 address.
}
],
"inner-vlan": "string", Match inner VLAN ID. {
"flow-tag": "integer" Match flow-tag. Should be value 1..63 or range.
range: "1..63"
}
],
"cos": "string", Match CoS.
range: "0..7"
"mpls-disposition-ipv6-access-list": "string", Match MPLS Label Disposition IPv6 access list.
"destination-mac": "string", Match destination MAC address.
"dei-inner": "integer", Match DEI INNER bit.
range: "0..1"
"remote-id-regex": "string", Match remote id regex.
"timer-regex": "string", Match timer regular expression. {
"netmask": "string", IPv4 netmask.
"address": "string" IPv4 address.
}
], {
"regex": "string", Domain name or regular expression.
"format": "string" Domain-format name.
}
],
"ipv6-dscp": "string", Match IPv6 DSCP.
"dei": "integer", Match DEI bit.
range: "0..1"
"icmpv4-code": "string", Match IPv4 ICMP code.\nShould be value 0..255 or range. {
"name": "string", Domain name or regular expression.
"format": "string" Domain-format name.
}
],
"remote-id": "string", Match remote ID.
"icmpv4-type": "string", Match IPv4 ICMP type.\nShould be value 0..255 or range.
"discard-class": "string", Match discard class.
range: "0..7"
"mpls-disposition-ipv4-access-list": "string", Match MPLS Label Disposition IPv4 access list.
"vpls-control": [ null ], Match VPLS control
"ipv6-precedence": "string" Match IPv6 precedence.
range: "0..7"
},
"type": "enumeration", Type of class-map.
Options:
qos
traffic
control
"class-map-mode-match-all": [ null ], Match any match criteria. {
"service-name-regex": "string", Match servicve name regular expression.
"protocol": "string", Match protocol.
"vpls-broadcast": [ null ], Match VPLS Broadcast
"precedence": "string", Match precedence.
range: "0..7"
"packet-length": "string", Match packet length.\nShould be value 0..65535 or range.
"fr-de": "integer", Match FrameRelay DE bit.
range: "0..1"
"cac-admit": [ null ], Match CAC admitted.
"circuit-id-regex": "string", Match Circuit id regex.
"atm-clp": "integer", Match ATM CLP bit.
range: "0..1"
"traffic-class": "string", Match Traffic Class.\nShould be value 0..63 or range.
"ipv6-packet-length": "string", Match IPv6 packet length.\nShould be value 0..65535 or range.
"icmpv6-code": "string", Match IPv6 ICMP code.\nShould be value 0..255 or range.
"timer": "string", Match timer.
"vpls-multicast": [ null ], Match VPLS Multicast
"service-name": "string", Match servicve name.
"fragment-type": "string", Match fragment type for a packet.
"flow-tag": "string", Match flow-tag. Should be value 1..63 or range.
"ipv4-packet-length": "string", Match IPv4 packet length.\nShould be value 0..65535 or range. {
"netmask": "string", IPv4 netmask.
"address": "string" IPv4 address.
}
], {
"prefix-length": "integer", IPv6 prefix length.
range: "0..128"
"address": "string" IPv4 address.
}
],
"authen-status": "string", Match authentication status.
"ipv4-precedence": "string", Match IPv4 precedence.
range: "0..7"
"ipv4-dscp": "string", Match IPv4 DSCP.
"tcp-flag": "integer", Match TCP flags.
range: "0..4095"
"ethertype": "string", Match Ethertype.
"mpls-experimental-topmost": "string", Match MPLS experimental topmost label.
range: "0..7"
"ethernet-services-acl": "string", Match Ethernet Services {
"flag": "string", Dhcp client id Ascii/Hex
"value": "string" Dhcp client Id.
}
],
"ipv4-acl": "string", Match IPv4 ACL.
"cac-unadmit": [ null ], Match CAC unadmitted.
"icmpv6-type": "string", Match IPv6 ICMP type.\nShould be value 0..255 or range.
"vpls-known": [ null ], Match VPLS Known
"destination-port": "string", Match destination port.\nShould be value 0..65535 or range. {
"flag": "string", Dhcp client id Ascii/Hex
"value": "string" Dhcp client Id.
}
],
"inner-cos": "string", Match inner CoS.
range: "0..7"
"frame-relay-dlci": "string", Match frame-relay DLCI value.\nShould be value 16..1007 or range.
"vpls-unknown": [ null ], Match VPLS Unknown
"vlan": "string", Match VLAN ID.
"user-name": "string", Match user name.
"dscp": "string", Match DSCP.
"mpls-experimental-imposition": "string", Match MPLS experimental imposition label.
range: "0..7"
"qos-group": "string", Match QoS group.\nShould be value 0..512 or range.
"source-mac": "string", Match source MAC address.
"circuit-id": "string", Match Circuit ID.
"ipv6-acl": "string", Match IPv6 ACL.
"atm-oam": [ null ], Match ATM OAM.
"source-port": "string", Match source port.\nShould be value 0..65535 or range.
"user-name-regex": "string", Match user name regular expression. {
"prefix-length": "integer", IPv6 prefix length.
range: "0..128"
"address": "string" IPv4 address.
}
],
"inner-vlan": "string", Match inner VLAN ID.
"cos": "string", Match CoS.
range: "0..7"
"mpls-disposition-ipv6-access-list": "string", Match MPLS Label Disposition IPv6 access list.
"destination-mac": "string", Match destination MAC address.
"dei-inner": "integer", Match DEI INNER bit.
range: "0..1"
"remote-id-regex": "string", Match remote id regex.
"timer-regex": "string", Match timer regular expression. {
"netmask": "string", IPv4 netmask.
"address": "string" IPv4 address.
}
], "flow-key": "string", Configure the flow-key parameters. {
"idle-timeout": "string" Maximum time of inactivity for a flow.
}
]
}, {
"regex": "string", Domain name or regular expression.
"format": "string" Domain-format name.
}
],
"ipv6-dscp": "string", Match IPv6 DSCP.
"dei": "integer", Match DEI bit.
range: "0..1"
"icmpv4-code": "string", Match IPv4 ICMP code.\nShould be value 0..255 or range. {
"name": "string", Domain name or regular expression.
"format": "string" Domain-format name.
}
],
"remote-id": "string", Match remote ID.
"icmpv4-type": "string", Match IPv4 ICMP type.\nShould be value 0..255 or range.
"discard-class": "string", Match discard class.
range: "0..7"
"mpls-disposition-ipv4-access-list": "string", Match MPLS Label Disposition IPv4 access list.
"vpls-control": [ null ], Match VPLS control
"ipv6-precedence": "string" Match IPv6 precedence.
range: "0..7"
}
],
"description": "string" Description for this policy-map.
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
CLASS-MAPS - Create
Create operation of resource: class-maps
class-mapsbody object
Request Content-Types: application/json
Request Example
{ {
"class-map-mode-match-any": [ null ], Match all match criteria
"name": "string", Domain name or regular expression. "service-name-regex": "string", Match servicve name regular expression.
"protocol": "string", Match protocol.
"vpls-broadcast": [ null ], Match VPLS Broadcast
"precedence": "string", Match precedence.
range: "0..7"
"packet-length": "string", Match packet length.\nShould be value 0..65535 or range.
"fr-de": "integer", Match FrameRelay DE bit.
range: "0..1"
"circuit-id-regex": "string", Match Circuit id regex.
"traffic-class": "string", Match Traffic Class.\nShould be value 0..63 or range.
"ipv6-packet-length": "string", Match IPv6 packet length.\nShould be value 0..65535 or range.
"icmpv6-code": "string", Match IPv6 ICMP code.\nShould be value 0..255 or range.
"timer": "string", Match timer.
"vpls-multicast": [ null ], Match VPLS Multicast
"service-name": "string", Match servicve name.
"fragment-type": "string", Match fragment type for a packet.
"flow-tag": "string", Match flow-tag. Should be value 1..63 or range.
"ipv4-packet-length": "string", Match IPv4 packet length.\nShould be value 0..65535 or range. {
"netmask": "string", IPv4 netmask.
"address": "string" IPv4 address.
}
], {
"prefix-length": "integer", IPv6 prefix length.
range: "0..128"
"address": "string" IPv4 address.
}
],
"authen-status": "string", Match authentication status.
"ipv4-precedence": "string", Match IPv4 precedence.
range: "0..7"
"ipv4-dscp": "string", Match IPv4 DSCP.
"tcp-flag": "integer", Match TCP flags.
range: "0..4095"
"ethertype": "string", Match Ethertype.
"mpls-experimental-topmost": "string", Match MPLS experimental topmost label.
range: "0..7"
"ethernet-services-acl": "string", Match Ethernet Services {
"flag": "string", Dhcp client id Ascii/Hex
"value": "string" Dhcp client Id.
}
],
"ipv4-acl": "string", Match IPv4 ACL.
"icmpv6-type": "string", Match IPv6 ICMP type.\nShould be value 0..255 or range.
"vpls-known": [ null ], Match VPLS Known
"destination-port": "string", Match destination port.\nShould be value 0..65535 or range. {
"flag": "string", Dhcp client id Ascii/Hex
"value": "string" Dhcp client Id.
}
],
"inner-cos": "string", Match inner CoS.
range: "0..7"
"frame-relay-dlci": "string", Match frame-relay DLCI value.\nShould be value 16..1007 or range.
"vpls-unknown": [ null ], Match VPLS Unknown
"vlan": "string", Match VLAN ID.
"user-name": "string", Match user name.
"dscp": "string", Match DSCP.
"mpls-experimental-imposition": "string", Match MPLS experimental imposition label.
range: "0..7"
"qos-group": "string", Match QoS group.\nShould be value 0..512 or range.
"source-mac": "string", Match source MAC address.
"circuit-id": "string", Match Circuit ID.
"ipv6-acl": "string", Match IPv6 ACL.
"source-port": "string", Match source port.\nShould be value 0..65535 or range.
"user-name-regex": "string", Match user name regular expression. {
"prefix-length": "integer", IPv6 prefix length.
range: "0..128"
"address": "string" IPv4 address.
}
],
"inner-vlan": "string", Match inner VLAN ID. {
"flow-tag": "integer" Match flow-tag. Should be value 1..63 or range.
range: "1..63"
}
],
"cos": "string", Match CoS.
range: "0..7"
"mpls-disposition-ipv6-access-list": "string", Match MPLS Label Disposition IPv6 access list.
"destination-mac": "string", Match destination MAC address.
"dei-inner": "integer", Match DEI INNER bit.
range: "0..1"
"remote-id-regex": "string", Match remote id regex.
"timer-regex": "string", Match timer regular expression. {
"netmask": "string", IPv4 netmask.
"address": "string" IPv4 address.
}
], {
"regex": "string", Domain name or regular expression.
"format": "string" Domain-format name.
}
],
"ipv6-dscp": "string", Match IPv6 DSCP.
"dei": "integer", Match DEI bit.
range: "0..1"
"icmpv4-code": "string", Match IPv4 ICMP code.\nShould be value 0..255 or range. {
"name": "string", Domain name or regular expression.
"format": "string" Domain-format name.
}
],
"remote-id": "string", Match remote ID.
"icmpv4-type": "string", Match IPv4 ICMP type.\nShould be value 0..255 or range.
"discard-class": "string", Match discard class.
range: "0..7"
"mpls-disposition-ipv4-access-list": "string", Match MPLS Label Disposition IPv4 access list.
"vpls-control": [ null ], Match VPLS control
"ipv6-precedence": "string" Match IPv6 precedence.
range: "0..7"
},
"type": "enumeration", Type of class-map.
Options:
qos
traffic
control
"class-map-mode-match-all": [ null ], Match any match criteria. {
"service-name-regex": "string", Match servicve name regular expression.
"protocol": "string", Match protocol.
"vpls-broadcast": [ null ], Match VPLS Broadcast
"precedence": "string", Match precedence.
range: "0..7"
"packet-length": "string", Match packet length.\nShould be value 0..65535 or range.
"fr-de": "integer", Match FrameRelay DE bit.
range: "0..1"
"cac-admit": [ null ], Match CAC admitted.
"circuit-id-regex": "string", Match Circuit id regex.
"atm-clp": "integer", Match ATM CLP bit.
range: "0..1"
"traffic-class": "string", Match Traffic Class.\nShould be value 0..63 or range.
"ipv6-packet-length": "string", Match IPv6 packet length.\nShould be value 0..65535 or range.
"icmpv6-code": "string", Match IPv6 ICMP code.\nShould be value 0..255 or range.
"timer": "string", Match timer.
"vpls-multicast": [ null ], Match VPLS Multicast
"service-name": "string", Match servicve name.
"fragment-type": "string", Match fragment type for a packet.
"flow-tag": "string", Match flow-tag. Should be value 1..63 or range.
"ipv4-packet-length": "string", Match IPv4 packet length.\nShould be value 0..65535 or range. {
"netmask": "string", IPv4 netmask.
"address": "string" IPv4 address.
}
], {
"prefix-length": "integer", IPv6 prefix length.
range: "0..128"
"address": "string" IPv4 address.
}
],
"authen-status": "string", Match authentication status.
"ipv4-precedence": "string", Match IPv4 precedence.
range: "0..7"
"ipv4-dscp": "string", Match IPv4 DSCP.
"tcp-flag": "integer", Match TCP flags.
range: "0..4095"
"ethertype": "string", Match Ethertype.
"mpls-experimental-topmost": "string", Match MPLS experimental topmost label.
range: "0..7"
"ethernet-services-acl": "string", Match Ethernet Services {
"flag": "string", Dhcp client id Ascii/Hex
"value": "string" Dhcp client Id.
}
],
"ipv4-acl": "string", Match IPv4 ACL.
"cac-unadmit": [ null ], Match CAC unadmitted.
"icmpv6-type": "string", Match IPv6 ICMP type.\nShould be value 0..255 or range.
"vpls-known": [ null ], Match VPLS Known
"destination-port": "string", Match destination port.\nShould be value 0..65535 or range. {
"flag": "string", Dhcp client id Ascii/Hex
"value": "string" Dhcp client Id.
}
],
"inner-cos": "string", Match inner CoS.
range: "0..7"
"frame-relay-dlci": "string", Match frame-relay DLCI value.\nShould be value 16..1007 or range.
"vpls-unknown": [ null ], Match VPLS Unknown
"vlan": "string", Match VLAN ID.
"user-name": "string", Match user name.
"dscp": "string", Match DSCP.
"mpls-experimental-imposition": "string", Match MPLS experimental imposition label.
range: "0..7"
"qos-group": "string", Match QoS group.\nShould be value 0..512 or range.
"source-mac": "string", Match source MAC address.
"circuit-id": "string", Match Circuit ID.
"ipv6-acl": "string", Match IPv6 ACL.
"atm-oam": [ null ], Match ATM OAM.
"source-port": "string", Match source port.\nShould be value 0..65535 or range.
"user-name-regex": "string", Match user name regular expression. {
"prefix-length": "integer", IPv6 prefix length.
range: "0..128"
"address": "string" IPv4 address.
}
],
"inner-vlan": "string", Match inner VLAN ID.
"cos": "string", Match CoS.
range: "0..7"
"mpls-disposition-ipv6-access-list": "string", Match MPLS Label Disposition IPv6 access list.
"destination-mac": "string", Match destination MAC address.
"dei-inner": "integer", Match DEI INNER bit.
range: "0..1"
"remote-id-regex": "string", Match remote id regex.
"timer-regex": "string", Match timer regular expression. {
"netmask": "string", IPv4 netmask.
"address": "string" IPv4 address.
}
], "flow-key": "string", Configure the flow-key parameters. {
"idle-timeout": "string" Maximum time of inactivity for a flow.
}
]
}, {
"regex": "string", Domain name or regular expression.
"format": "string" Domain-format name.
}
],
"ipv6-dscp": "string", Match IPv6 DSCP.
"dei": "integer", Match DEI bit.
range: "0..1"
"icmpv4-code": "string", Match IPv4 ICMP code.\nShould be value 0..255 or range. {
"name": "string", Domain name or regular expression.
"format": "string" Domain-format name.
}
],
"remote-id": "string", Match remote ID.
"icmpv4-type": "string", Match IPv4 ICMP type.\nShould be value 0..255 or range.
"discard-class": "string", Match discard class.
range: "0..7"
"mpls-disposition-ipv4-access-list": "string", Match MPLS Label Disposition IPv4 access list.
"vpls-control": [ null ], Match VPLS control
"ipv6-precedence": "string" Match IPv6 precedence.
range: "0..7"
}
],
"description": "string" Description for this policy-map.
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
CLASS-MAPS - Delete
Delete operation of resource: class-maps
Successful operation
Internal Error
Response Content-Types: application/json
CLASS-MAPS - Retrieve
Retrieve operation of resource: class-maps
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"class-map-mode-match-any": [ null ], Match all match criteria
"name": "string", Domain name or regular expression. "service-name-regex": "string", Match servicve name regular expression.
"protocol": "string", Match protocol.
"vpls-broadcast": [ null ], Match VPLS Broadcast
"precedence": "string", Match precedence.
range: "0..7"
"packet-length": "string", Match packet length.\nShould be value 0..65535 or range.
"fr-de": "integer", Match FrameRelay DE bit.
range: "0..1"
"circuit-id-regex": "string", Match Circuit id regex.
"traffic-class": "string", Match Traffic Class.\nShould be value 0..63 or range.
"ipv6-packet-length": "string", Match IPv6 packet length.\nShould be value 0..65535 or range.
"icmpv6-code": "string", Match IPv6 ICMP code.\nShould be value 0..255 or range.
"timer": "string", Match timer.
"vpls-multicast": [ null ], Match VPLS Multicast
"service-name": "string", Match servicve name.
"fragment-type": "string", Match fragment type for a packet.
"flow-tag": "string", Match flow-tag. Should be value 1..63 or range.
"ipv4-packet-length": "string", Match IPv4 packet length.\nShould be value 0..65535 or range. {
"netmask": "string", IPv4 netmask.
"address": "string" IPv4 address.
}
], {
"prefix-length": "integer", IPv6 prefix length.
range: "0..128"
"address": "string" IPv4 address.
}
],
"authen-status": "string", Match authentication status.
"ipv4-precedence": "string", Match IPv4 precedence.
range: "0..7"
"ipv4-dscp": "string", Match IPv4 DSCP.
"tcp-flag": "integer", Match TCP flags.
range: "0..4095"
"ethertype": "string", Match Ethertype.
"mpls-experimental-topmost": "string", Match MPLS experimental topmost label.
range: "0..7"
"ethernet-services-acl": "string", Match Ethernet Services {
"flag": "string", Dhcp client id Ascii/Hex
"value": "string" Dhcp client Id.
}
],
"ipv4-acl": "string", Match IPv4 ACL.
"icmpv6-type": "string", Match IPv6 ICMP type.\nShould be value 0..255 or range.
"vpls-known": [ null ], Match VPLS Known
"destination-port": "string", Match destination port.\nShould be value 0..65535 or range. {
"flag": "string", Dhcp client id Ascii/Hex
"value": "string" Dhcp client Id.
}
],
"inner-cos": "string", Match inner CoS.
range: "0..7"
"frame-relay-dlci": "string", Match frame-relay DLCI value.\nShould be value 16..1007 or range.
"vpls-unknown": [ null ], Match VPLS Unknown
"vlan": "string", Match VLAN ID.
"user-name": "string", Match user name.
"dscp": "string", Match DSCP.
"mpls-experimental-imposition": "string", Match MPLS experimental imposition label.
range: "0..7"
"qos-group": "string", Match QoS group.\nShould be value 0..512 or range.
"source-mac": "string", Match source MAC address.
"circuit-id": "string", Match Circuit ID.
"ipv6-acl": "string", Match IPv6 ACL.
"source-port": "string", Match source port.\nShould be value 0..65535 or range.
"user-name-regex": "string", Match user name regular expression. {
"prefix-length": "integer", IPv6 prefix length.
range: "0..128"
"address": "string" IPv4 address.
}
],
"inner-vlan": "string", Match inner VLAN ID. {
"flow-tag": "integer" Match flow-tag. Should be value 1..63 or range.
range: "1..63"
}
],
"cos": "string", Match CoS.
range: "0..7"
"mpls-disposition-ipv6-access-list": "string", Match MPLS Label Disposition IPv6 access list.
"destination-mac": "string", Match destination MAC address.
"dei-inner": "integer", Match DEI INNER bit.
range: "0..1"
"remote-id-regex": "string", Match remote id regex.
"timer-regex": "string", Match timer regular expression. {
"netmask": "string", IPv4 netmask.
"address": "string" IPv4 address.
}
], {
"regex": "string", Domain name or regular expression.
"format": "string" Domain-format name.
}
],
"ipv6-dscp": "string", Match IPv6 DSCP.
"dei": "integer", Match DEI bit.
range: "0..1"
"icmpv4-code": "string", Match IPv4 ICMP code.\nShould be value 0..255 or range. {
"name": "string", Domain name or regular expression.
"format": "string" Domain-format name.
}
],
"remote-id": "string", Match remote ID.
"icmpv4-type": "string", Match IPv4 ICMP type.\nShould be value 0..255 or range.
"discard-class": "string", Match discard class.
range: "0..7"
"mpls-disposition-ipv4-access-list": "string", Match MPLS Label Disposition IPv4 access list.
"vpls-control": [ null ], Match VPLS control
"ipv6-precedence": "string" Match IPv6 precedence.
range: "0..7"
},
"type": "enumeration", Type of class-map.
Options:
qos
traffic
control
"class-map-mode-match-all": [ null ], Match any match criteria. {
"service-name-regex": "string", Match servicve name regular expression.
"protocol": "string", Match protocol.
"vpls-broadcast": [ null ], Match VPLS Broadcast
"precedence": "string", Match precedence.
range: "0..7"
"packet-length": "string", Match packet length.\nShould be value 0..65535 or range.
"fr-de": "integer", Match FrameRelay DE bit.
range: "0..1"
"cac-admit": [ null ], Match CAC admitted.
"circuit-id-regex": "string", Match Circuit id regex.
"atm-clp": "integer", Match ATM CLP bit.
range: "0..1"
"traffic-class": "string", Match Traffic Class.\nShould be value 0..63 or range.
"ipv6-packet-length": "string", Match IPv6 packet length.\nShould be value 0..65535 or range.
"icmpv6-code": "string", Match IPv6 ICMP code.\nShould be value 0..255 or range.
"timer": "string", Match timer.
"vpls-multicast": [ null ], Match VPLS Multicast
"service-name": "string", Match servicve name.
"fragment-type": "string", Match fragment type for a packet.
"flow-tag": "string", Match flow-tag. Should be value 1..63 or range.
"ipv4-packet-length": "string", Match IPv4 packet length.\nShould be value 0..65535 or range. {
"netmask": "string", IPv4 netmask.
"address": "string" IPv4 address.
}
], {
"prefix-length": "integer", IPv6 prefix length.
range: "0..128"
"address": "string" IPv4 address.
}
],
"authen-status": "string", Match authentication status.
"ipv4-precedence": "string", Match IPv4 precedence.
range: "0..7"
"ipv4-dscp": "string", Match IPv4 DSCP.
"tcp-flag": "integer", Match TCP flags.
range: "0..4095"
"ethertype": "string", Match Ethertype.
"mpls-experimental-topmost": "string", Match MPLS experimental topmost label.
range: "0..7"
"ethernet-services-acl": "string", Match Ethernet Services {
"flag": "string", Dhcp client id Ascii/Hex
"value": "string" Dhcp client Id.
}
],
"ipv4-acl": "string", Match IPv4 ACL.
"cac-unadmit": [ null ], Match CAC unadmitted.
"icmpv6-type": "string", Match IPv6 ICMP type.\nShould be value 0..255 or range.
"vpls-known": [ null ], Match VPLS Known
"destination-port": "string", Match destination port.\nShould be value 0..65535 or range. {
"flag": "string", Dhcp client id Ascii/Hex
"value": "string" Dhcp client Id.
}
],
"inner-cos": "string", Match inner CoS.
range: "0..7"
"frame-relay-dlci": "string", Match frame-relay DLCI value.\nShould be value 16..1007 or range.
"vpls-unknown": [ null ], Match VPLS Unknown
"vlan": "string", Match VLAN ID.
"user-name": "string", Match user name.
"dscp": "string", Match DSCP.
"mpls-experimental-imposition": "string", Match MPLS experimental imposition label.
range: "0..7"
"qos-group": "string", Match QoS group.\nShould be value 0..512 or range.
"source-mac": "string", Match source MAC address.
"circuit-id": "string", Match Circuit ID.
"ipv6-acl": "string", Match IPv6 ACL.
"atm-oam": [ null ], Match ATM OAM.
"source-port": "string", Match source port.\nShould be value 0..65535 or range.
"user-name-regex": "string", Match user name regular expression. {
"prefix-length": "integer", IPv6 prefix length.
range: "0..128"
"address": "string" IPv4 address.
}
],
"inner-vlan": "string", Match inner VLAN ID.
"cos": "string", Match CoS.
range: "0..7"
"mpls-disposition-ipv6-access-list": "string", Match MPLS Label Disposition IPv6 access list.
"destination-mac": "string", Match destination MAC address.
"dei-inner": "integer", Match DEI INNER bit.
range: "0..1"
"remote-id-regex": "string", Match remote id regex.
"timer-regex": "string", Match timer regular expression. {
"netmask": "string", IPv4 netmask.
"address": "string" IPv4 address.
}
], "flow-key": "string", Configure the flow-key parameters. {
"idle-timeout": "string" Maximum time of inactivity for a flow.
}
]
}, {
"regex": "string", Domain name or regular expression.
"format": "string" Domain-format name.
}
],
"ipv6-dscp": "string", Match IPv6 DSCP.
"dei": "integer", Match DEI bit.
range: "0..1"
"icmpv4-code": "string", Match IPv4 ICMP code.\nShould be value 0..255 or range. {
"name": "string", Domain name or regular expression.
"format": "string" Domain-format name.
}
],
"remote-id": "string", Match remote ID.
"icmpv4-type": "string", Match IPv4 ICMP type.\nShould be value 0..255 or range.
"discard-class": "string", Match discard class.
range: "0..7"
"mpls-disposition-ipv4-access-list": "string", Match MPLS Label Disposition IPv4 access list.
"vpls-control": [ null ], Match VPLS control
"ipv6-precedence": "string" Match IPv6 precedence.
range: "0..7"
}
],
"description": "string" Description for this policy-map.
}
]
}
}
CLASS-MAP - Update
Update operation of resource: class-map
class-mapbody object
ID of type name
Request Content-Types: application/json
Request Example
{ {
"class-map-mode-match-any": [ null ], Match all match criteria
"name": "string", Domain name or regular expression. "service-name-regex": "string", Match servicve name regular expression.
"protocol": "string", Match protocol.
"vpls-broadcast": [ null ], Match VPLS Broadcast
"precedence": "string", Match precedence.
range: "0..7"
"packet-length": "string", Match packet length.\nShould be value 0..65535 or range.
"fr-de": "integer", Match FrameRelay DE bit.
range: "0..1"
"circuit-id-regex": "string", Match Circuit id regex.
"traffic-class": "string", Match Traffic Class.\nShould be value 0..63 or range.
"ipv6-packet-length": "string", Match IPv6 packet length.\nShould be value 0..65535 or range.
"icmpv6-code": "string", Match IPv6 ICMP code.\nShould be value 0..255 or range.
"timer": "string", Match timer.
"vpls-multicast": [ null ], Match VPLS Multicast
"service-name": "string", Match servicve name.
"fragment-type": "string", Match fragment type for a packet.
"flow-tag": "string", Match flow-tag. Should be value 1..63 or range.
"ipv4-packet-length": "string", Match IPv4 packet length.\nShould be value 0..65535 or range. {
"netmask": "string", IPv4 netmask.
"address": "string" IPv4 address.
}
], {
"prefix-length": "integer", IPv6 prefix length.
range: "0..128"
"address": "string" IPv4 address.
}
],
"authen-status": "string", Match authentication status.
"ipv4-precedence": "string", Match IPv4 precedence.
range: "0..7"
"ipv4-dscp": "string", Match IPv4 DSCP.
"tcp-flag": "integer", Match TCP flags.
range: "0..4095"
"ethertype": "string", Match Ethertype.
"mpls-experimental-topmost": "string", Match MPLS experimental topmost label.
range: "0..7"
"ethernet-services-acl": "string", Match Ethernet Services {
"flag": "string", Dhcp client id Ascii/Hex
"value": "string" Dhcp client Id.
}
],
"ipv4-acl": "string", Match IPv4 ACL.
"icmpv6-type": "string", Match IPv6 ICMP type.\nShould be value 0..255 or range.
"vpls-known": [ null ], Match VPLS Known
"destination-port": "string", Match destination port.\nShould be value 0..65535 or range. {
"flag": "string", Dhcp client id Ascii/Hex
"value": "string" Dhcp client Id.
}
],
"inner-cos": "string", Match inner CoS.
range: "0..7"
"frame-relay-dlci": "string", Match frame-relay DLCI value.\nShould be value 16..1007 or range.
"vpls-unknown": [ null ], Match VPLS Unknown
"vlan": "string", Match VLAN ID.
"user-name": "string", Match user name.
"dscp": "string", Match DSCP.
"mpls-experimental-imposition": "string", Match MPLS experimental imposition label.
range: "0..7"
"qos-group": "string", Match QoS group.\nShould be value 0..512 or range.
"source-mac": "string", Match source MAC address.
"circuit-id": "string", Match Circuit ID.
"ipv6-acl": "string", Match IPv6 ACL.
"source-port": "string", Match source port.\nShould be value 0..65535 or range.
"user-name-regex": "string", Match user name regular expression. {
"prefix-length": "integer", IPv6 prefix length.
range: "0..128"
"address": "string" IPv4 address.
}
],
"inner-vlan": "string", Match inner VLAN ID. {
"flow-tag": "integer" Match flow-tag. Should be value 1..63 or range.
range: "1..63"
}
],
"cos": "string", Match CoS.
range: "0..7"
"mpls-disposition-ipv6-access-list": "string", Match MPLS Label Disposition IPv6 access list.
"destination-mac": "string", Match destination MAC address.
"dei-inner": "integer", Match DEI INNER bit.
range: "0..1"
"remote-id-regex": "string", Match remote id regex.
"timer-regex": "string", Match timer regular expression. {
"netmask": "string", IPv4 netmask.
"address": "string" IPv4 address.
}
], {
"regex": "string", Domain name or regular expression.
"format": "string" Domain-format name.
}
],
"ipv6-dscp": "string", Match IPv6 DSCP.
"dei": "integer", Match DEI bit.
range: "0..1"
"icmpv4-code": "string", Match IPv4 ICMP code.\nShould be value 0..255 or range. {
"name": "string", Domain name or regular expression.
"format": "string" Domain-format name.
}
],
"remote-id": "string", Match remote ID.
"icmpv4-type": "string", Match IPv4 ICMP type.\nShould be value 0..255 or range.
"discard-class": "string", Match discard class.
range: "0..7"
"mpls-disposition-ipv4-access-list": "string", Match MPLS Label Disposition IPv4 access list.
"vpls-control": [ null ], Match VPLS control
"ipv6-precedence": "string" Match IPv6 precedence.
range: "0..7"
},
"type": "enumeration", Type of class-map.
Options:
qos
traffic
control
"class-map-mode-match-all": [ null ], Match any match criteria. {
"service-name-regex": "string", Match servicve name regular expression.
"protocol": "string", Match protocol.
"vpls-broadcast": [ null ], Match VPLS Broadcast
"precedence": "string", Match precedence.
range: "0..7"
"packet-length": "string", Match packet length.\nShould be value 0..65535 or range.
"fr-de": "integer", Match FrameRelay DE bit.
range: "0..1"
"cac-admit": [ null ], Match CAC admitted.
"circuit-id-regex": "string", Match Circuit id regex.
"atm-clp": "integer", Match ATM CLP bit.
range: "0..1"
"traffic-class": "string", Match Traffic Class.\nShould be value 0..63 or range.
"ipv6-packet-length": "string", Match IPv6 packet length.\nShould be value 0..65535 or range.
"icmpv6-code": "string", Match IPv6 ICMP code.\nShould be value 0..255 or range.
"timer": "string", Match timer.
"vpls-multicast": [ null ], Match VPLS Multicast
"service-name": "string", Match servicve name.
"fragment-type": "string", Match fragment type for a packet.
"flow-tag": "string", Match flow-tag. Should be value 1..63 or range.
"ipv4-packet-length": "string", Match IPv4 packet length.\nShould be value 0..65535 or range. {
"netmask": "string", IPv4 netmask.
"address": "string" IPv4 address.
}
], {
"prefix-length": "integer", IPv6 prefix length.
range: "0..128"
"address": "string" IPv4 address.
}
],
"authen-status": "string", Match authentication status.
"ipv4-precedence": "string", Match IPv4 precedence.
range: "0..7"
"ipv4-dscp": "string", Match IPv4 DSCP.
"tcp-flag": "integer", Match TCP flags.
range: "0..4095"
"ethertype": "string", Match Ethertype.
"mpls-experimental-topmost": "string", Match MPLS experimental topmost label.
range: "0..7"
"ethernet-services-acl": "string", Match Ethernet Services {
"flag": "string", Dhcp client id Ascii/Hex
"value": "string" Dhcp client Id.
}
],
"ipv4-acl": "string", Match IPv4 ACL.
"cac-unadmit": [ null ], Match CAC unadmitted.
"icmpv6-type": "string", Match IPv6 ICMP type.\nShould be value 0..255 or range.
"vpls-known": [ null ], Match VPLS Known
"destination-port": "string", Match destination port.\nShould be value 0..65535 or range. {
"flag": "string", Dhcp client id Ascii/Hex
"value": "string" Dhcp client Id.
}
],
"inner-cos": "string", Match inner CoS.
range: "0..7"
"frame-relay-dlci": "string", Match frame-relay DLCI value.\nShould be value 16..1007 or range.
"vpls-unknown": [ null ], Match VPLS Unknown
"vlan": "string", Match VLAN ID.
"user-name": "string", Match user name.
"dscp": "string", Match DSCP.
"mpls-experimental-imposition": "string", Match MPLS experimental imposition label.
range: "0..7"
"qos-group": "string", Match QoS group.\nShould be value 0..512 or range.
"source-mac": "string", Match source MAC address.
"circuit-id": "string", Match Circuit ID.
"ipv6-acl": "string", Match IPv6 ACL.
"atm-oam": [ null ], Match ATM OAM.
"source-port": "string", Match source port.\nShould be value 0..65535 or range.
"user-name-regex": "string", Match user name regular expression. {
"prefix-length": "integer", IPv6 prefix length.
range: "0..128"
"address": "string" IPv4 address.
}
],
"inner-vlan": "string", Match inner VLAN ID.
"cos": "string", Match CoS.
range: "0..7"
"mpls-disposition-ipv6-access-list": "string", Match MPLS Label Disposition IPv6 access list.
"destination-mac": "string", Match destination MAC address.
"dei-inner": "integer", Match DEI INNER bit.
range: "0..1"
"remote-id-regex": "string", Match remote id regex.
"timer-regex": "string", Match timer regular expression. {
"netmask": "string", IPv4 netmask.
"address": "string" IPv4 address.
}
], "flow-key": "string", Configure the flow-key parameters. {
"idle-timeout": "string" Maximum time of inactivity for a flow.
}
]
}, {
"regex": "string", Domain name or regular expression.
"format": "string" Domain-format name.
}
],
"ipv6-dscp": "string", Match IPv6 DSCP.
"dei": "integer", Match DEI bit.
range: "0..1"
"icmpv4-code": "string", Match IPv4 ICMP code.\nShould be value 0..255 or range. {
"name": "string", Domain name or regular expression.
"format": "string" Domain-format name.
}
],
"remote-id": "string", Match remote ID.
"icmpv4-type": "string", Match IPv4 ICMP type.\nShould be value 0..255 or range.
"discard-class": "string", Match discard class.
range: "0..7"
"mpls-disposition-ipv4-access-list": "string", Match MPLS Label Disposition IPv4 access list.
"vpls-control": [ null ], Match VPLS control
"ipv6-precedence": "string" Match IPv6 precedence.
range: "0..7"
}
],
"description": "string" Description for this policy-map.
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
CLASS-MAP - Create
Create operation of resource: class-map
class-mapbody object
ID of type name
Request Content-Types: application/json
Request Example
{ {
"class-map-mode-match-any": [ null ], Match all match criteria
"name": "string", Domain name or regular expression. "service-name-regex": "string", Match servicve name regular expression.
"protocol": "string", Match protocol.
"vpls-broadcast": [ null ], Match VPLS Broadcast
"precedence": "string", Match precedence.
range: "0..7"
"packet-length": "string", Match packet length.\nShould be value 0..65535 or range.
"fr-de": "integer", Match FrameRelay DE bit.
range: "0..1"
"circuit-id-regex": "string", Match Circuit id regex.
"traffic-class": "string", Match Traffic Class.\nShould be value 0..63 or range.
"ipv6-packet-length": "string", Match IPv6 packet length.\nShould be value 0..65535 or range.
"icmpv6-code": "string", Match IPv6 ICMP code.\nShould be value 0..255 or range.
"timer": "string", Match timer.
"vpls-multicast": [ null ], Match VPLS Multicast
"service-name": "string", Match servicve name.
"fragment-type": "string", Match fragment type for a packet.
"flow-tag": "string", Match flow-tag. Should be value 1..63 or range.
"ipv4-packet-length": "string", Match IPv4 packet length.\nShould be value 0..65535 or range. {
"netmask": "string", IPv4 netmask.
"address": "string" IPv4 address.
}
], {
"prefix-length": "integer", IPv6 prefix length.
range: "0..128"
"address": "string" IPv4 address.
}
],
"authen-status": "string", Match authentication status.
"ipv4-precedence": "string", Match IPv4 precedence.
range: "0..7"
"ipv4-dscp": "string", Match IPv4 DSCP.
"tcp-flag": "integer", Match TCP flags.
range: "0..4095"
"ethertype": "string", Match Ethertype.
"mpls-experimental-topmost": "string", Match MPLS experimental topmost label.
range: "0..7"
"ethernet-services-acl": "string", Match Ethernet Services {
"flag": "string", Dhcp client id Ascii/Hex
"value": "string" Dhcp client Id.
}
],
"ipv4-acl": "string", Match IPv4 ACL.
"icmpv6-type": "string", Match IPv6 ICMP type.\nShould be value 0..255 or range.
"vpls-known": [ null ], Match VPLS Known
"destination-port": "string", Match destination port.\nShould be value 0..65535 or range. {
"flag": "string", Dhcp client id Ascii/Hex
"value": "string" Dhcp client Id.
}
],
"inner-cos": "string", Match inner CoS.
range: "0..7"
"frame-relay-dlci": "string", Match frame-relay DLCI value.\nShould be value 16..1007 or range.
"vpls-unknown": [ null ], Match VPLS Unknown
"vlan": "string", Match VLAN ID.
"user-name": "string", Match user name.
"dscp": "string", Match DSCP.
"mpls-experimental-imposition": "string", Match MPLS experimental imposition label.
range: "0..7"
"qos-group": "string", Match QoS group.\nShould be value 0..512 or range.
"source-mac": "string", Match source MAC address.
"circuit-id": "string", Match Circuit ID.
"ipv6-acl": "string", Match IPv6 ACL.
"source-port": "string", Match source port.\nShould be value 0..65535 or range.
"user-name-regex": "string", Match user name regular expression. {
"prefix-length": "integer", IPv6 prefix length.
range: "0..128"
"address": "string" IPv4 address.
}
],
"inner-vlan": "string", Match inner VLAN ID. {
"flow-tag": "integer" Match flow-tag. Should be value 1..63 or range.
range: "1..63"
}
],
"cos": "string", Match CoS.
range: "0..7"
"mpls-disposition-ipv6-access-list": "string", Match MPLS Label Disposition IPv6 access list.
"destination-mac": "string", Match destination MAC address.
"dei-inner": "integer", Match DEI INNER bit.
range: "0..1"
"remote-id-regex": "string", Match remote id regex.
"timer-regex": "string", Match timer regular expression. {
"netmask": "string", IPv4 netmask.
"address": "string" IPv4 address.
}
], {
"regex": "string", Domain name or regular expression.
"format": "string" Domain-format name.
}
],
"ipv6-dscp": "string", Match IPv6 DSCP.
"dei": "integer", Match DEI bit.
range: "0..1"
"icmpv4-code": "string", Match IPv4 ICMP code.\nShould be value 0..255 or range. {
"name": "string", Domain name or regular expression.
"format": "string" Domain-format name.
}
],
"remote-id": "string", Match remote ID.
"icmpv4-type": "string", Match IPv4 ICMP type.\nShould be value 0..255 or range.
"discard-class": "string", Match discard class.
range: "0..7"
"mpls-disposition-ipv4-access-list": "string", Match MPLS Label Disposition IPv4 access list.
"vpls-control": [ null ], Match VPLS control
"ipv6-precedence": "string" Match IPv6 precedence.
range: "0..7"
},
"type": "enumeration", Type of class-map.
Options:
qos
traffic
control
"class-map-mode-match-all": [ null ], Match any match criteria. {
"service-name-regex": "string", Match servicve name regular expression.
"protocol": "string", Match protocol.
"vpls-broadcast": [ null ], Match VPLS Broadcast
"precedence": "string", Match precedence.
range: "0..7"
"packet-length": "string", Match packet length.\nShould be value 0..65535 or range.
"fr-de": "integer", Match FrameRelay DE bit.
range: "0..1"
"cac-admit": [ null ], Match CAC admitted.
"circuit-id-regex": "string", Match Circuit id regex.
"atm-clp": "integer", Match ATM CLP bit.
range: "0..1"
"traffic-class": "string", Match Traffic Class.\nShould be value 0..63 or range.
"ipv6-packet-length": "string", Match IPv6 packet length.\nShould be value 0..65535 or range.
"icmpv6-code": "string", Match IPv6 ICMP code.\nShould be value 0..255 or range.
"timer": "string", Match timer.
"vpls-multicast": [ null ], Match VPLS Multicast
"service-name": "string", Match servicve name.
"fragment-type": "string", Match fragment type for a packet.
"flow-tag": "string", Match flow-tag. Should be value 1..63 or range.
"ipv4-packet-length": "string", Match IPv4 packet length.\nShould be value 0..65535 or range. {
"netmask": "string", IPv4 netmask.
"address": "string" IPv4 address.
}
], {
"prefix-length": "integer", IPv6 prefix length.
range: "0..128"
"address": "string" IPv4 address.
}
],
"authen-status": "string", Match authentication status.
"ipv4-precedence": "string", Match IPv4 precedence.
range: "0..7"
"ipv4-dscp": "string", Match IPv4 DSCP.
"tcp-flag": "integer", Match TCP flags.
range: "0..4095"
"ethertype": "string", Match Ethertype.
"mpls-experimental-topmost": "string", Match MPLS experimental topmost label.
range: "0..7"
"ethernet-services-acl": "string", Match Ethernet Services {
"flag": "string", Dhcp client id Ascii/Hex
"value": "string" Dhcp client Id.
}
],
"ipv4-acl": "string", Match IPv4 ACL.
"cac-unadmit": [ null ], Match CAC unadmitted.
"icmpv6-type": "string", Match IPv6 ICMP type.\nShould be value 0..255 or range.
"vpls-known": [ null ], Match VPLS Known
"destination-port": "string", Match destination port.\nShould be value 0..65535 or range. {
"flag": "string", Dhcp client id Ascii/Hex
"value": "string" Dhcp client Id.
}
],
"inner-cos": "string", Match inner CoS.
range: "0..7"
"frame-relay-dlci": "string", Match frame-relay DLCI value.\nShould be value 16..1007 or range.
"vpls-unknown": [ null ], Match VPLS Unknown
"vlan": "string", Match VLAN ID.
"user-name": "string", Match user name.
"dscp": "string", Match DSCP.
"mpls-experimental-imposition": "string", Match MPLS experimental imposition label.
range: "0..7"
"qos-group": "string", Match QoS group.\nShould be value 0..512 or range.
"source-mac": "string", Match source MAC address.
"circuit-id": "string", Match Circuit ID.
"ipv6-acl": "string", Match IPv6 ACL.
"atm-oam": [ null ], Match ATM OAM.
"source-port": "string", Match source port.\nShould be value 0..65535 or range.
"user-name-regex": "string", Match user name regular expression. {
"prefix-length": "integer", IPv6 prefix length.
range: "0..128"
"address": "string" IPv4 address.
}
],
"inner-vlan": "string", Match inner VLAN ID.
"cos": "string", Match CoS.
range: "0..7"
"mpls-disposition-ipv6-access-list": "string", Match MPLS Label Disposition IPv6 access list.
"destination-mac": "string", Match destination MAC address.
"dei-inner": "integer", Match DEI INNER bit.
range: "0..1"
"remote-id-regex": "string", Match remote id regex.
"timer-regex": "string", Match timer regular expression. {
"netmask": "string", IPv4 netmask.
"address": "string" IPv4 address.
}
], "flow-key": "string", Configure the flow-key parameters. {
"idle-timeout": "string" Maximum time of inactivity for a flow.
}
]
}, {
"regex": "string", Domain name or regular expression.
"format": "string" Domain-format name.
}
],
"ipv6-dscp": "string", Match IPv6 DSCP.
"dei": "integer", Match DEI bit.
range: "0..1"
"icmpv4-code": "string", Match IPv4 ICMP code.\nShould be value 0..255 or range. {
"name": "string", Domain name or regular expression.
"format": "string" Domain-format name.
}
],
"remote-id": "string", Match remote ID.
"icmpv4-type": "string", Match IPv4 ICMP type.\nShould be value 0..255 or range.
"discard-class": "string", Match discard class.
range: "0..7"
"mpls-disposition-ipv4-access-list": "string", Match MPLS Label Disposition IPv4 access list.
"vpls-control": [ null ], Match VPLS control
"ipv6-precedence": "string" Match IPv6 precedence.
range: "0..7"
}
],
"description": "string" Description for this policy-map.
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
CLASS-MAP - Delete
Delete operation of resource: class-map
ID of type name
Successful operation
Internal Error
Response Content-Types: application/json
CLASS-MAP - Retrieve
Retrieve operation of resource: class-map
ID of type name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"class-map-mode-match-any": [ null ], Match all match criteria
"name": "string", Domain name or regular expression. "service-name-regex": "string", Match servicve name regular expression.
"protocol": "string", Match protocol.
"vpls-broadcast": [ null ], Match VPLS Broadcast
"precedence": "string", Match precedence.
range: "0..7"
"packet-length": "string", Match packet length.\nShould be value 0..65535 or range.
"fr-de": "integer", Match FrameRelay DE bit.
range: "0..1"
"circuit-id-regex": "string", Match Circuit id regex.
"traffic-class": "string", Match Traffic Class.\nShould be value 0..63 or range.
"ipv6-packet-length": "string", Match IPv6 packet length.\nShould be value 0..65535 or range.
"icmpv6-code": "string", Match IPv6 ICMP code.\nShould be value 0..255 or range.
"timer": "string", Match timer.
"vpls-multicast": [ null ], Match VPLS Multicast
"service-name": "string", Match servicve name.
"fragment-type": "string", Match fragment type for a packet.
"flow-tag": "string", Match flow-tag. Should be value 1..63 or range.
"ipv4-packet-length": "string", Match IPv4 packet length.\nShould be value 0..65535 or range. {
"netmask": "string", IPv4 netmask.
"address": "string" IPv4 address.
}
], {
"prefix-length": "integer", IPv6 prefix length.
range: "0..128"
"address": "string" IPv4 address.
}
],
"authen-status": "string", Match authentication status.
"ipv4-precedence": "string", Match IPv4 precedence.
range: "0..7"
"ipv4-dscp": "string", Match IPv4 DSCP.
"tcp-flag": "integer", Match TCP flags.
range: "0..4095"
"ethertype": "string", Match Ethertype.
"mpls-experimental-topmost": "string", Match MPLS experimental topmost label.
range: "0..7"
"ethernet-services-acl": "string", Match Ethernet Services {
"flag": "string", Dhcp client id Ascii/Hex
"value": "string" Dhcp client Id.
}
],
"ipv4-acl": "string", Match IPv4 ACL.
"icmpv6-type": "string", Match IPv6 ICMP type.\nShould be value 0..255 or range.
"vpls-known": [ null ], Match VPLS Known
"destination-port": "string", Match destination port.\nShould be value 0..65535 or range. {
"flag": "string", Dhcp client id Ascii/Hex
"value": "string" Dhcp client Id.
}
],
"inner-cos": "string", Match inner CoS.
range: "0..7"
"frame-relay-dlci": "string", Match frame-relay DLCI value.\nShould be value 16..1007 or range.
"vpls-unknown": [ null ], Match VPLS Unknown
"vlan": "string", Match VLAN ID.
"user-name": "string", Match user name.
"dscp": "string", Match DSCP.
"mpls-experimental-imposition": "string", Match MPLS experimental imposition label.
range: "0..7"
"qos-group": "string", Match QoS group.\nShould be value 0..512 or range.
"source-mac": "string", Match source MAC address.
"circuit-id": "string", Match Circuit ID.
"ipv6-acl": "string", Match IPv6 ACL.
"source-port": "string", Match source port.\nShould be value 0..65535 or range.
"user-name-regex": "string", Match user name regular expression. {
"prefix-length": "integer", IPv6 prefix length.
range: "0..128"
"address": "string" IPv4 address.
}
],
"inner-vlan": "string", Match inner VLAN ID. {
"flow-tag": "integer" Match flow-tag. Should be value 1..63 or range.
range: "1..63"
}
],
"cos": "string", Match CoS.
range: "0..7"
"mpls-disposition-ipv6-access-list": "string", Match MPLS Label Disposition IPv6 access list.
"destination-mac": "string", Match destination MAC address.
"dei-inner": "integer", Match DEI INNER bit.
range: "0..1"
"remote-id-regex": "string", Match remote id regex.
"timer-regex": "string", Match timer regular expression. {
"netmask": "string", IPv4 netmask.
"address": "string" IPv4 address.
}
], {
"regex": "string", Domain name or regular expression.
"format": "string" Domain-format name.
}
],
"ipv6-dscp": "string", Match IPv6 DSCP.
"dei": "integer", Match DEI bit.
range: "0..1"
"icmpv4-code": "string", Match IPv4 ICMP code.\nShould be value 0..255 or range. {
"name": "string", Domain name or regular expression.
"format": "string" Domain-format name.
}
],
"remote-id": "string", Match remote ID.
"icmpv4-type": "string", Match IPv4 ICMP type.\nShould be value 0..255 or range.
"discard-class": "string", Match discard class.
range: "0..7"
"mpls-disposition-ipv4-access-list": "string", Match MPLS Label Disposition IPv4 access list.
"vpls-control": [ null ], Match VPLS control
"ipv6-precedence": "string" Match IPv6 precedence.
range: "0..7"
},
"type": "enumeration", Type of class-map.
Options:
qos
traffic
control
"class-map-mode-match-all": [ null ], Match any match criteria. {
"service-name-regex": "string", Match servicve name regular expression.
"protocol": "string", Match protocol.
"vpls-broadcast": [ null ], Match VPLS Broadcast
"precedence": "string", Match precedence.
range: "0..7"
"packet-length": "string", Match packet length.\nShould be value 0..65535 or range.
"fr-de": "integer", Match FrameRelay DE bit.
range: "0..1"
"cac-admit": [ null ], Match CAC admitted.
"circuit-id-regex": "string", Match Circuit id regex.
"atm-clp": "integer", Match ATM CLP bit.
range: "0..1"
"traffic-class": "string", Match Traffic Class.\nShould be value 0..63 or range.
"ipv6-packet-length": "string", Match IPv6 packet length.\nShould be value 0..65535 or range.
"icmpv6-code": "string", Match IPv6 ICMP code.\nShould be value 0..255 or range.
"timer": "string", Match timer.
"vpls-multicast": [ null ], Match VPLS Multicast
"service-name": "string", Match servicve name.
"fragment-type": "string", Match fragment type for a packet.
"flow-tag": "string", Match flow-tag. Should be value 1..63 or range.
"ipv4-packet-length": "string", Match IPv4 packet length.\nShould be value 0..65535 or range. {
"netmask": "string", IPv4 netmask.
"address": "string" IPv4 address.
}
], {
"prefix-length": "integer", IPv6 prefix length.
range: "0..128"
"address": "string" IPv4 address.
}
],
"authen-status": "string", Match authentication status.
"ipv4-precedence": "string", Match IPv4 precedence.
range: "0..7"
"ipv4-dscp": "string", Match IPv4 DSCP.
"tcp-flag": "integer", Match TCP flags.
range: "0..4095"
"ethertype": "string", Match Ethertype.
"mpls-experimental-topmost": "string", Match MPLS experimental topmost label.
range: "0..7"
"ethernet-services-acl": "string", Match Ethernet Services {
"flag": "string", Dhcp client id Ascii/Hex
"value": "string" Dhcp client Id.
}
],
"ipv4-acl": "string", Match IPv4 ACL.
"cac-unadmit": [ null ], Match CAC unadmitted.
"icmpv6-type": "string", Match IPv6 ICMP type.\nShould be value 0..255 or range.
"vpls-known": [ null ], Match VPLS Known
"destination-port": "string", Match destination port.\nShould be value 0..65535 or range. {
"flag": "string", Dhcp client id Ascii/Hex
"value": "string" Dhcp client Id.
}
],
"inner-cos": "string", Match inner CoS.
range: "0..7"
"frame-relay-dlci": "string", Match frame-relay DLCI value.\nShould be value 16..1007 or range.
"vpls-unknown": [ null ], Match VPLS Unknown
"vlan": "string", Match VLAN ID.
"user-name": "string", Match user name.
"dscp": "string", Match DSCP.
"mpls-experimental-imposition": "string", Match MPLS experimental imposition label.
range: "0..7"
"qos-group": "string", Match QoS group.\nShould be value 0..512 or range.
"source-mac": "string", Match source MAC address.
"circuit-id": "string", Match Circuit ID.
"ipv6-acl": "string", Match IPv6 ACL.
"atm-oam": [ null ], Match ATM OAM.
"source-port": "string", Match source port.\nShould be value 0..65535 or range.
"user-name-regex": "string", Match user name regular expression. {
"prefix-length": "integer", IPv6 prefix length.
range: "0..128"
"address": "string" IPv4 address.
}
],
"inner-vlan": "string", Match inner VLAN ID.
"cos": "string", Match CoS.
range: "0..7"
"mpls-disposition-ipv6-access-list": "string", Match MPLS Label Disposition IPv6 access list.
"destination-mac": "string", Match destination MAC address.
"dei-inner": "integer", Match DEI INNER bit.
range: "0..1"
"remote-id-regex": "string", Match remote id regex.
"timer-regex": "string", Match timer regular expression. {
"netmask": "string", IPv4 netmask.
"address": "string" IPv4 address.
}
], "flow-key": "string", Configure the flow-key parameters. {
"idle-timeout": "string" Maximum time of inactivity for a flow.
}
]
}, {
"regex": "string", Domain name or regular expression.
"format": "string" Domain-format name.
}
],
"ipv6-dscp": "string", Match IPv6 DSCP.
"dei": "integer", Match DEI bit.
range: "0..1"
"icmpv4-code": "string", Match IPv4 ICMP code.\nShould be value 0..255 or range. {
"name": "string", Domain name or regular expression.
"format": "string" Domain-format name.
}
],
"remote-id": "string", Match remote ID.
"icmpv4-type": "string", Match IPv4 ICMP type.\nShould be value 0..255 or range.
"discard-class": "string", Match discard class.
range: "0..7"
"mpls-disposition-ipv4-access-list": "string", Match MPLS Label Disposition IPv4 access list.
"vpls-control": [ null ], Match VPLS control
"ipv6-precedence": "string" Match IPv6 precedence.
range: "0..7"
}
],
"description": "string" Description for this policy-map.
}
]
}
MATCH - Update
Update operation of resource: match
matchbody object
ID of type name
Request Content-Types: application/json
Request Example
{ "service-name-regex": "string", Match servicve name regular expression.
"protocol": "string", Match protocol.
"vpls-broadcast": [ null ], Match VPLS Broadcast
"precedence": "string", Match precedence.
range: "0..7"
"packet-length": "string", Match packet length.\nShould be value 0..65535 or range.
"fr-de": "integer", Match FrameRelay DE bit.
range: "0..1"
"cac-admit": [ null ], Match CAC admitted.
"circuit-id-regex": "string", Match Circuit id regex.
"atm-clp": "integer", Match ATM CLP bit.
range: "0..1"
"traffic-class": "string", Match Traffic Class.\nShould be value 0..63 or range.
"ipv6-packet-length": "string", Match IPv6 packet length.\nShould be value 0..65535 or range.
"icmpv6-code": "string", Match IPv6 ICMP code.\nShould be value 0..255 or range.
"timer": "string", Match timer.
"vpls-multicast": [ null ], Match VPLS Multicast
"service-name": "string", Match servicve name.
"fragment-type": "string", Match fragment type for a packet.
"flow-tag": "string", Match flow-tag. Should be value 1..63 or range.
"ipv4-packet-length": "string", Match IPv4 packet length.\nShould be value 0..65535 or range. {
"netmask": "string", IPv4 netmask.
"address": "string" IPv4 address.
}
], {
"prefix-length": "integer", IPv6 prefix length.
range: "0..128"
"address": "string" IPv4 address.
}
],
"authen-status": "string", Match authentication status.
"ipv4-precedence": "string", Match IPv4 precedence.
range: "0..7"
"ipv4-dscp": "string", Match IPv4 DSCP.
"tcp-flag": "integer", Match TCP flags.
range: "0..4095"
"ethertype": "string", Match Ethertype.
"mpls-experimental-topmost": "string", Match MPLS experimental topmost label.
range: "0..7"
"ethernet-services-acl": "string", Match Ethernet Services {
"flag": "string", Dhcp client id Ascii/Hex
"value": "string" Dhcp client Id.
}
],
"ipv4-acl": "string", Match IPv4 ACL.
"cac-unadmit": [ null ], Match CAC unadmitted.
"icmpv6-type": "string", Match IPv6 ICMP type.\nShould be value 0..255 or range.
"vpls-known": [ null ], Match VPLS Known
"destination-port": "string", Match destination port.\nShould be value 0..65535 or range. {
"flag": "string", Dhcp client id Ascii/Hex
"value": "string" Dhcp client Id.
}
],
"inner-cos": "string", Match inner CoS.
range: "0..7"
"frame-relay-dlci": "string", Match frame-relay DLCI value.\nShould be value 16..1007 or range.
"vpls-unknown": [ null ], Match VPLS Unknown
"vlan": "string", Match VLAN ID.
"user-name": "string", Match user name.
"dscp": "string", Match DSCP.
"mpls-experimental-imposition": "string", Match MPLS experimental imposition label.
range: "0..7"
"qos-group": "string", Match QoS group.\nShould be value 0..512 or range.
"source-mac": "string", Match source MAC address.
"circuit-id": "string", Match Circuit ID.
"ipv6-acl": "string", Match IPv6 ACL.
"atm-oam": [ null ], Match ATM OAM.
"source-port": "string", Match source port.\nShould be value 0..65535 or range.
"user-name-regex": "string", Match user name regular expression. {
"prefix-length": "integer", IPv6 prefix length.
range: "0..128"
"address": "string" IPv4 address.
}
],
"inner-vlan": "string", Match inner VLAN ID.
"cos": "string", Match CoS.
range: "0..7"
"mpls-disposition-ipv6-access-list": "string", Match MPLS Label Disposition IPv6 access list.
"destination-mac": "string", Match destination MAC address.
"dei-inner": "integer", Match DEI INNER bit.
range: "0..1"
"remote-id-regex": "string", Match remote id regex.
"timer-regex": "string", Match timer regular expression. {
"netmask": "string", IPv4 netmask.
"address": "string" IPv4 address.
}
], "flow-key": "string", Configure the flow-key parameters. {
"idle-timeout": "string" Maximum time of inactivity for a flow.
}
]
}, {
"regex": "string", Domain name or regular expression.
"format": "string" Domain-format name.
}
],
"ipv6-dscp": "string", Match IPv6 DSCP.
"dei": "integer", Match DEI bit.
range: "0..1"
"icmpv4-code": "string", Match IPv4 ICMP code.\nShould be value 0..255 or range. {
"name": "string", Domain name or regular expression.
"format": "string" Domain-format name.
}
],
"remote-id": "string", Match remote ID.
"icmpv4-type": "string", Match IPv4 ICMP type.\nShould be value 0..255 or range.
"discard-class": "string", Match discard class.
range: "0..7"
"mpls-disposition-ipv4-access-list": "string", Match MPLS Label Disposition IPv4 access list.
"vpls-control": [ null ], Match VPLS control
"ipv6-precedence": "string" Match IPv6 precedence.
range: "0..7"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
MATCH - Create
Create operation of resource: match
matchbody object
ID of type name
Request Content-Types: application/json
Request Example
{ "service-name-regex": "string", Match servicve name regular expression.
"protocol": "string", Match protocol.
"vpls-broadcast": [ null ], Match VPLS Broadcast
"precedence": "string", Match precedence.
range: "0..7"
"packet-length": "string", Match packet length.\nShould be value 0..65535 or range.
"fr-de": "integer", Match FrameRelay DE bit.
range: "0..1"
"cac-admit": [ null ], Match CAC admitted.
"circuit-id-regex": "string", Match Circuit id regex.
"atm-clp": "integer", Match ATM CLP bit.
range: "0..1"
"traffic-class": "string", Match Traffic Class.\nShould be value 0..63 or range.
"ipv6-packet-length": "string", Match IPv6 packet length.\nShould be value 0..65535 or range.
"icmpv6-code": "string", Match IPv6 ICMP code.\nShould be value 0..255 or range.
"timer": "string", Match timer.
"vpls-multicast": [ null ], Match VPLS Multicast
"service-name": "string", Match servicve name.
"fragment-type": "string", Match fragment type for a packet.
"flow-tag": "string", Match flow-tag. Should be value 1..63 or range.
"ipv4-packet-length": "string", Match IPv4 packet length.\nShould be value 0..65535 or range. {
"netmask": "string", IPv4 netmask.
"address": "string" IPv4 address.
}
], {
"prefix-length": "integer", IPv6 prefix length.
range: "0..128"
"address": "string" IPv4 address.
}
],
"authen-status": "string", Match authentication status.
"ipv4-precedence": "string", Match IPv4 precedence.
range: "0..7"
"ipv4-dscp": "string", Match IPv4 DSCP.
"tcp-flag": "integer", Match TCP flags.
range: "0..4095"
"ethertype": "string", Match Ethertype.
"mpls-experimental-topmost": "string", Match MPLS experimental topmost label.
range: "0..7"
"ethernet-services-acl": "string", Match Ethernet Services {
"flag": "string", Dhcp client id Ascii/Hex
"value": "string" Dhcp client Id.
}
],
"ipv4-acl": "string", Match IPv4 ACL.
"cac-unadmit": [ null ], Match CAC unadmitted.
"icmpv6-type": "string", Match IPv6 ICMP type.\nShould be value 0..255 or range.
"vpls-known": [ null ], Match VPLS Known
"destination-port": "string", Match destination port.\nShould be value 0..65535 or range. {
"flag": "string", Dhcp client id Ascii/Hex
"value": "string" Dhcp client Id.
}
],
"inner-cos": "string", Match inner CoS.
range: "0..7"
"frame-relay-dlci": "string", Match frame-relay DLCI value.\nShould be value 16..1007 or range.
"vpls-unknown": [ null ], Match VPLS Unknown
"vlan": "string", Match VLAN ID.
"user-name": "string", Match user name.
"dscp": "string", Match DSCP.
"mpls-experimental-imposition": "string", Match MPLS experimental imposition label.
range: "0..7"
"qos-group": "string", Match QoS group.\nShould be value 0..512 or range.
"source-mac": "string", Match source MAC address.
"circuit-id": "string", Match Circuit ID.
"ipv6-acl": "string", Match IPv6 ACL.
"atm-oam": [ null ], Match ATM OAM.
"source-port": "string", Match source port.\nShould be value 0..65535 or range.
"user-name-regex": "string", Match user name regular expression. {
"prefix-length": "integer", IPv6 prefix length.
range: "0..128"
"address": "string" IPv4 address.
}
],
"inner-vlan": "string", Match inner VLAN ID.
"cos": "string", Match CoS.
range: "0..7"
"mpls-disposition-ipv6-access-list": "string", Match MPLS Label Disposition IPv6 access list.
"destination-mac": "string", Match destination MAC address.
"dei-inner": "integer", Match DEI INNER bit.
range: "0..1"
"remote-id-regex": "string", Match remote id regex.
"timer-regex": "string", Match timer regular expression. {
"netmask": "string", IPv4 netmask.
"address": "string" IPv4 address.
}
], "flow-key": "string", Configure the flow-key parameters. {
"idle-timeout": "string" Maximum time of inactivity for a flow.
}
]
}, {
"regex": "string", Domain name or regular expression.
"format": "string" Domain-format name.
}
],
"ipv6-dscp": "string", Match IPv6 DSCP.
"dei": "integer", Match DEI bit.
range: "0..1"
"icmpv4-code": "string", Match IPv4 ICMP code.\nShould be value 0..255 or range. {
"name": "string", Domain name or regular expression.
"format": "string" Domain-format name.
}
],
"remote-id": "string", Match remote ID.
"icmpv4-type": "string", Match IPv4 ICMP type.\nShould be value 0..255 or range.
"discard-class": "string", Match discard class.
range: "0..7"
"mpls-disposition-ipv4-access-list": "string", Match MPLS Label Disposition IPv4 access list.
"vpls-control": [ null ], Match VPLS control
"ipv6-precedence": "string" Match IPv6 precedence.
range: "0..7"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
MATCH - Delete
Delete operation of resource: match
ID of type name
Successful operation
Internal Error
Response Content-Types: application/json
MATCH - Retrieve
Retrieve operation of resource: match
ID of type name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "service-name-regex": "string", Match servicve name regular expression.
"protocol": "string", Match protocol.
"vpls-broadcast": [ null ], Match VPLS Broadcast
"precedence": "string", Match precedence.
range: "0..7"
"packet-length": "string", Match packet length.\nShould be value 0..65535 or range.
"fr-de": "integer", Match FrameRelay DE bit.
range: "0..1"
"cac-admit": [ null ], Match CAC admitted.
"circuit-id-regex": "string", Match Circuit id regex.
"atm-clp": "integer", Match ATM CLP bit.
range: "0..1"
"traffic-class": "string", Match Traffic Class.\nShould be value 0..63 or range.
"ipv6-packet-length": "string", Match IPv6 packet length.\nShould be value 0..65535 or range.
"icmpv6-code": "string", Match IPv6 ICMP code.\nShould be value 0..255 or range.
"timer": "string", Match timer.
"vpls-multicast": [ null ], Match VPLS Multicast
"service-name": "string", Match servicve name.
"fragment-type": "string", Match fragment type for a packet.
"flow-tag": "string", Match flow-tag. Should be value 1..63 or range.
"ipv4-packet-length": "string", Match IPv4 packet length.\nShould be value 0..65535 or range. {
"netmask": "string", IPv4 netmask.
"address": "string" IPv4 address.
}
], {
"prefix-length": "integer", IPv6 prefix length.
range: "0..128"
"address": "string" IPv4 address.
}
],
"authen-status": "string", Match authentication status.
"ipv4-precedence": "string", Match IPv4 precedence.
range: "0..7"
"ipv4-dscp": "string", Match IPv4 DSCP.
"tcp-flag": "integer", Match TCP flags.
range: "0..4095"
"ethertype": "string", Match Ethertype.
"mpls-experimental-topmost": "string", Match MPLS experimental topmost label.
range: "0..7"
"ethernet-services-acl": "string", Match Ethernet Services {
"flag": "string", Dhcp client id Ascii/Hex
"value": "string" Dhcp client Id.
}
],
"ipv4-acl": "string", Match IPv4 ACL.
"cac-unadmit": [ null ], Match CAC unadmitted.
"icmpv6-type": "string", Match IPv6 ICMP type.\nShould be value 0..255 or range.
"vpls-known": [ null ], Match VPLS Known
"destination-port": "string", Match destination port.\nShould be value 0..65535 or range. {
"flag": "string", Dhcp client id Ascii/Hex
"value": "string" Dhcp client Id.
}
],
"inner-cos": "string", Match inner CoS.
range: "0..7"
"frame-relay-dlci": "string", Match frame-relay DLCI value.\nShould be value 16..1007 or range.
"vpls-unknown": [ null ], Match VPLS Unknown
"vlan": "string", Match VLAN ID.
"user-name": "string", Match user name.
"dscp": "string", Match DSCP.
"mpls-experimental-imposition": "string", Match MPLS experimental imposition label.
range: "0..7"
"qos-group": "string", Match QoS group.\nShould be value 0..512 or range.
"source-mac": "string", Match source MAC address.
"circuit-id": "string", Match Circuit ID.
"ipv6-acl": "string", Match IPv6 ACL.
"atm-oam": [ null ], Match ATM OAM.
"source-port": "string", Match source port.\nShould be value 0..65535 or range.
"user-name-regex": "string", Match user name regular expression. {
"prefix-length": "integer", IPv6 prefix length.
range: "0..128"
"address": "string" IPv4 address.
}
],
"inner-vlan": "string", Match inner VLAN ID.
"cos": "string", Match CoS.
range: "0..7"
"mpls-disposition-ipv6-access-list": "string", Match MPLS Label Disposition IPv6 access list.
"destination-mac": "string", Match destination MAC address.
"dei-inner": "integer", Match DEI INNER bit.
range: "0..1"
"remote-id-regex": "string", Match remote id regex.
"timer-regex": "string", Match timer regular expression. {
"netmask": "string", IPv4 netmask.
"address": "string" IPv4 address.
}
], "flow-key": "string", Configure the flow-key parameters. {
"idle-timeout": "string" Maximum time of inactivity for a flow.
}
]
}, {
"regex": "string", Domain name or regular expression.
"format": "string" Domain-format name.
}
],
"ipv6-dscp": "string", Match IPv6 DSCP.
"dei": "integer", Match DEI bit.
range: "0..1"
"icmpv4-code": "string", Match IPv4 ICMP code.\nShould be value 0..255 or range. {
"name": "string", Domain name or regular expression.
"format": "string" Domain-format name.
}
],
"remote-id": "string", Match remote ID.
"icmpv4-type": "string", Match IPv4 ICMP type.\nShould be value 0..255 or range.
"discard-class": "string", Match discard class.
range: "0..7"
"mpls-disposition-ipv4-access-list": "string", Match MPLS Label Disposition IPv4 access list.
"vpls-control": [ null ], Match VPLS control
"ipv6-precedence": "string" Match IPv6 precedence.
range: "0..7"
}
}
DESTINATION-ADDRESS-IPV4 - Update
Update operation of resource: destination-address-ipv4
destination-address-ipv4body object
ID of type name
ID of address netmask
Successful operation
Internal Error
Response Content-Types: application/json
DESTINATION-ADDRESS-IPV4 - Create
Create operation of resource: destination-address-ipv4
destination-address-ipv4body object
ID of type name
ID of address netmask
Successful operation
Internal Error
Response Content-Types: application/json
DESTINATION-ADDRESS-IPV4 - Delete
Delete operation of resource: destination-address-ipv4
ID of type name
ID of address netmask
Successful operation
Internal Error
Response Content-Types: application/json
DESTINATION-ADDRESS-IPV4 - Retrieve
Retrieve operation of resource: destination-address-ipv4
ID of type name
ID of address netmask
Successful operation
Internal Error
DESTINATION-ADDRESS-IPV6 - Update
Update operation of resource: destination-address-ipv6
destination-address-ipv6body object
ID of type name
ID of address prefix-length
Successful operation
Internal Error
Response Content-Types: application/json
DESTINATION-ADDRESS-IPV6 - Create
Create operation of resource: destination-address-ipv6
destination-address-ipv6body object
ID of type name
ID of address prefix-length
Successful operation
Internal Error
Response Content-Types: application/json
DESTINATION-ADDRESS-IPV6 - Delete
Delete operation of resource: destination-address-ipv6
ID of type name
ID of address prefix-length
Successful operation
Internal Error
Response Content-Types: application/json
DESTINATION-ADDRESS-IPV6 - Retrieve
Retrieve operation of resource: destination-address-ipv6
ID of type name
ID of address prefix-length
Successful operation
Internal Error
SOURCE-ADDRESS-IPV4 - Update
Update operation of resource: source-address-ipv4
source-address-ipv4body object
ID of type name
ID of address netmask
Successful operation
Internal Error
Response Content-Types: application/json
SOURCE-ADDRESS-IPV4 - Create
Create operation of resource: source-address-ipv4
source-address-ipv4body object
ID of type name
ID of address netmask
Successful operation
Internal Error
Response Content-Types: application/json
SOURCE-ADDRESS-IPV4 - Delete
Delete operation of resource: source-address-ipv4
ID of type name
ID of address netmask
Successful operation
Internal Error
Response Content-Types: application/json
SOURCE-ADDRESS-IPV4 - Retrieve
Retrieve operation of resource: source-address-ipv4
ID of type name
ID of address netmask
Successful operation
Internal Error
SOURCE-ADDRESS-IPV6 - Update
Update operation of resource: source-address-ipv6
source-address-ipv6body object
ID of type name
ID of address prefix-length
Successful operation
Internal Error
Response Content-Types: application/json
SOURCE-ADDRESS-IPV6 - Create
Create operation of resource: source-address-ipv6
source-address-ipv6body object
ID of type name
ID of address prefix-length
Successful operation
Internal Error
Response Content-Types: application/json
SOURCE-ADDRESS-IPV6 - Delete
Delete operation of resource: source-address-ipv6
ID of type name
ID of address prefix-length
Successful operation
Internal Error
Response Content-Types: application/json
SOURCE-ADDRESS-IPV6 - Retrieve
Retrieve operation of resource: source-address-ipv6
ID of type name
ID of address prefix-length
Successful operation
Internal Error
DHCP-CLIENT-ID - Update
Update operation of resource: dhcp-client-id
dhcp-client-idbody object
ID of type name
ID of value flag
Successful operation
Internal Error
Response Content-Types: application/json
DHCP-CLIENT-ID - Create
Create operation of resource: dhcp-client-id
dhcp-client-idbody object
ID of type name
ID of value flag
Successful operation
Internal Error
Response Content-Types: application/json
DHCP-CLIENT-ID - Delete
Delete operation of resource: dhcp-client-id
ID of type name
ID of value flag
Successful operation
Internal Error
Response Content-Types: application/json
DHCP-CLIENT-ID - Retrieve
Retrieve operation of resource: dhcp-client-id
ID of type name
ID of value flag
Successful operation
Internal Error
DHCP-CLIENT-ID-REGEX - Update
Update operation of resource: dhcp-client-id-regex
dhcp-client-id-regexbody object
ID of type name
ID of value flag
Successful operation
Internal Error
Response Content-Types: application/json
DHCP-CLIENT-ID-REGEX - Create
Create operation of resource: dhcp-client-id-regex
dhcp-client-id-regexbody object
ID of type name
ID of value flag
Successful operation
Internal Error
Response Content-Types: application/json
DHCP-CLIENT-ID-REGEX - Delete
Delete operation of resource: dhcp-client-id-regex
ID of type name
ID of value flag
Successful operation
Internal Error
Response Content-Types: application/json
DHCP-CLIENT-ID-REGEX - Retrieve
Retrieve operation of resource: dhcp-client-id-regex
ID of type name
ID of value flag
Successful operation
Internal Error
DOMAIN-NAME - Update
Update operation of resource: domain-name
domain-namebody object
ID of type name
ID of name format
Successful operation
Internal Error
Response Content-Types: application/json
DOMAIN-NAME - Create
Create operation of resource: domain-name
domain-namebody object
ID of type name
ID of name format
Successful operation
Internal Error
Response Content-Types: application/json
DOMAIN-NAME - Delete
Delete operation of resource: domain-name
ID of type name
ID of name format
Successful operation
Internal Error
Response Content-Types: application/json
DOMAIN-NAME - Retrieve
Retrieve operation of resource: domain-name
ID of type name
ID of name format
Successful operation
Internal Error
DOMAIN-NAME-REGEX - Update
Update operation of resource: domain-name-regex
domain-name-regexbody object
ID of type name
ID of regex format
Successful operation
Internal Error
Response Content-Types: application/json
DOMAIN-NAME-REGEX - Create
Create operation of resource: domain-name-regex
domain-name-regexbody object
ID of type name
ID of regex format
Successful operation
Internal Error
Response Content-Types: application/json
DOMAIN-NAME-REGEX - Delete
Delete operation of resource: domain-name-regex
ID of type name
ID of regex format
Successful operation
Internal Error
Response Content-Types: application/json
DOMAIN-NAME-REGEX - Retrieve
Retrieve operation of resource: domain-name-regex
ID of type name
ID of regex format
Successful operation
Internal Error
FLOW - Update
Update operation of resource: flow
flowbody object
ID of type name
Successful operation
Internal Error
Response Content-Types: application/json
FLOW - Create
Create operation of resource: flow
flowbody object
ID of type name
Successful operation
Internal Error
Response Content-Types: application/json
FLOW - Delete
Delete operation of resource: flow
ID of type name
Successful operation
Internal Error
Response Content-Types: application/json
FLOW - Retrieve
Retrieve operation of resource: flow
ID of type name
Successful operation
Internal Error
FLOW-CACHE - Update
Update operation of resource: flow-cache
flow-cachebody object
ID of type name
Successful operation
Internal Error
Response Content-Types: application/json
FLOW-CACHE - Create
Create operation of resource: flow-cache
flow-cachebody object
ID of type name
Successful operation
Internal Error
Response Content-Types: application/json
FLOW-CACHE - Delete
Delete operation of resource: flow-cache
ID of type name
Successful operation
Internal Error
Response Content-Types: application/json
FLOW-CACHE - Retrieve
Retrieve operation of resource: flow-cache
ID of type name
Successful operation
Internal Error
MATCH-NOT - Update
Update operation of resource: match-not
match-notbody object
ID of type name
Request Content-Types: application/json
Request Example
{ "service-name-regex": "string", Match servicve name regular expression.
"protocol": "string", Match protocol.
"vpls-broadcast": [ null ], Match VPLS Broadcast
"precedence": "string", Match precedence.
range: "0..7"
"packet-length": "string", Match packet length.\nShould be value 0..65535 or range.
"fr-de": "integer", Match FrameRelay DE bit.
range: "0..1"
"circuit-id-regex": "string", Match Circuit id regex.
"traffic-class": "string", Match Traffic Class.\nShould be value 0..63 or range.
"ipv6-packet-length": "string", Match IPv6 packet length.\nShould be value 0..65535 or range.
"icmpv6-code": "string", Match IPv6 ICMP code.\nShould be value 0..255 or range.
"timer": "string", Match timer.
"vpls-multicast": [ null ], Match VPLS Multicast
"service-name": "string", Match servicve name.
"fragment-type": "string", Match fragment type for a packet.
"flow-tag": "string", Configure the flow-tag parameters.
"ipv4-packet-length": "string", Match IPv4 packet length.\nShould be value 0..65535 or range. {
"netmask": "string", IPv4 netmask.
"address": "string" IPv4 address.
}
], {
"prefix-length": "integer", IPv6 prefix length.
range: "0..128"
"address": "string" IPv4 address.
}
],
"authen-status": "string", Match authentication status.
"ipv4-precedence": "string", Match IPv4 precedence.
range: "0..7"
"ipv4-dscp": "string", Match IPv4 DSCP.
"tcp-flag": "integer", Match TCP flags.
range: "0..4095"
"ethertype": "string", Match Ethertype.
"mpls-experimental-topmost": "string", Match MPLS experimental topmost label.
range: "0..7"
"ethernet-services-acl": "string", Match Ethernet Services {
"flag": "string", Dhcp client id Ascii/Hex
"value": "string" Dhcp client Id.
}
],
"ipv4-acl": "string", Match IPv4 ACL.
"icmpv6-type": "string", Match IPv6 ICMP type.\nShould be value 0..255 or range.
"vpls-known": [ null ], Match VPLS Known
"destination-port": "string", Match destination port.\nShould be value 0..65535 or range. {
"flag": "string", Dhcp client id Ascii/Hex
"value": "string" Dhcp client Id.
}
],
"inner-cos": "string", Match inner CoS.
range: "0..7"
"frame-relay-dlci": "string", Match frame-relay DLCI value.\nShould be value 16..1007 or range.
"vpls-unknown": [ null ], Match VPLS Unknown
"vlan": "string", Match VLAN ID.
"user-name": "string", Match user name.
"dscp": "string", Match DSCP.
"mpls-experimental-imposition": "string", Match MPLS experimental imposition label.
range: "0..7"
"qos-group": "string", Match QoS group.\nShould be value 0..512 or range.
"source-mac": "string", Match source MAC address.
"circuit-id": "string", Match Circuit ID.
"ipv6-acl": "string", Match IPv6 ACL.
"source-port": "string", Match source port.\nShould be value 0..65535 or range.
"user-name-regex": "string", Match user name regular expression. {
"prefix-length": "integer", IPv6 prefix length.
range: "0..128"
"address": "string" IPv4 address.
}
],
"inner-vlan": "string", Match inner VLAN ID. {
"flow-tag": "integer" Configure the flow-tag parameters.
range: "1..63"
}
],
"cos": "string", Match CoS.
range: "0..7"
"mpls-disposition-ipv6-access-list": "string", Match MPLS Label Disposition IPv6 access list.
"destination-mac": "string", Match destination MAC address.
"dei-inner": "integer", Match DEI INNER bit.
range: "0..1"
"remote-id-regex": "string", Match remote id regex.
"timer-regex": "string", Match timer regular expression. {
"netmask": "string", IPv4 netmask.
"address": "string" IPv4 address.
}
], {
"regex": "string", Domain name or regular expression.
"format": "string" Domain-format name.
}
],
"ipv6-dscp": "string", Match IPv6 DSCP.
"dei": "integer", Match DEI bit.
range: "0..1"
"icmpv4-code": "string", Match IPv4 ICMP code.\nShould be value 0..255 or range. {
"name": "string", Domain name or regular expression.
"format": "string" Domain-format name.
}
],
"remote-id": "string", Match remote ID.
"icmpv4-type": "string", Match IPv4 ICMP type.\nShould be value 0..255 or range.
"discard-class": "string", Match discard class.
range: "0..7"
"mpls-disposition-ipv4-access-list": "string", Match MPLS Label Disposition IPv4 access list.
"vpls-control": [ null ], Match VPLS control
"ipv6-precedence": "string" Match IPv6 precedence.
range: "0..7"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
MATCH-NOT - Create
Create operation of resource: match-not
match-notbody object
ID of type name
Request Content-Types: application/json
Request Example
{ "service-name-regex": "string", Match servicve name regular expression.
"protocol": "string", Match protocol.
"vpls-broadcast": [ null ], Match VPLS Broadcast
"precedence": "string", Match precedence.
range: "0..7"
"packet-length": "string", Match packet length.\nShould be value 0..65535 or range.
"fr-de": "integer", Match FrameRelay DE bit.
range: "0..1"
"circuit-id-regex": "string", Match Circuit id regex.
"traffic-class": "string", Match Traffic Class.\nShould be value 0..63 or range.
"ipv6-packet-length": "string", Match IPv6 packet length.\nShould be value 0..65535 or range.
"icmpv6-code": "string", Match IPv6 ICMP code.\nShould be value 0..255 or range.
"timer": "string", Match timer.
"vpls-multicast": [ null ], Match VPLS Multicast
"service-name": "string", Match servicve name.
"fragment-type": "string", Match fragment type for a packet.
"flow-tag": "string", Configure the flow-tag parameters.
"ipv4-packet-length": "string", Match IPv4 packet length.\nShould be value 0..65535 or range. {
"netmask": "string", IPv4 netmask.
"address": "string" IPv4 address.
}
], {
"prefix-length": "integer", IPv6 prefix length.
range: "0..128"
"address": "string" IPv4 address.
}
],
"authen-status": "string", Match authentication status.
"ipv4-precedence": "string", Match IPv4 precedence.
range: "0..7"
"ipv4-dscp": "string", Match IPv4 DSCP.
"tcp-flag": "integer", Match TCP flags.
range: "0..4095"
"ethertype": "string", Match Ethertype.
"mpls-experimental-topmost": "string", Match MPLS experimental topmost label.
range: "0..7"
"ethernet-services-acl": "string", Match Ethernet Services {
"flag": "string", Dhcp client id Ascii/Hex
"value": "string" Dhcp client Id.
}
],
"ipv4-acl": "string", Match IPv4 ACL.
"icmpv6-type": "string", Match IPv6 ICMP type.\nShould be value 0..255 or range.
"vpls-known": [ null ], Match VPLS Known
"destination-port": "string", Match destination port.\nShould be value 0..65535 or range. {
"flag": "string", Dhcp client id Ascii/Hex
"value": "string" Dhcp client Id.
}
],
"inner-cos": "string", Match inner CoS.
range: "0..7"
"frame-relay-dlci": "string", Match frame-relay DLCI value.\nShould be value 16..1007 or range.
"vpls-unknown": [ null ], Match VPLS Unknown
"vlan": "string", Match VLAN ID.
"user-name": "string", Match user name.
"dscp": "string", Match DSCP.
"mpls-experimental-imposition": "string", Match MPLS experimental imposition label.
range: "0..7"
"qos-group": "string", Match QoS group.\nShould be value 0..512 or range.
"source-mac": "string", Match source MAC address.
"circuit-id": "string", Match Circuit ID.
"ipv6-acl": "string", Match IPv6 ACL.
"source-port": "string", Match source port.\nShould be value 0..65535 or range.
"user-name-regex": "string", Match user name regular expression. {
"prefix-length": "integer", IPv6 prefix length.
range: "0..128"
"address": "string" IPv4 address.
}
],
"inner-vlan": "string", Match inner VLAN ID. {
"flow-tag": "integer" Configure the flow-tag parameters.
range: "1..63"
}
],
"cos": "string", Match CoS.
range: "0..7"
"mpls-disposition-ipv6-access-list": "string", Match MPLS Label Disposition IPv6 access list.
"destination-mac": "string", Match destination MAC address.
"dei-inner": "integer", Match DEI INNER bit.
range: "0..1"
"remote-id-regex": "string", Match remote id regex.
"timer-regex": "string", Match timer regular expression. {
"netmask": "string", IPv4 netmask.
"address": "string" IPv4 address.
}
], {
"regex": "string", Domain name or regular expression.
"format": "string" Domain-format name.
}
],
"ipv6-dscp": "string", Match IPv6 DSCP.
"dei": "integer", Match DEI bit.
range: "0..1"
"icmpv4-code": "string", Match IPv4 ICMP code.\nShould be value 0..255 or range. {
"name": "string", Domain name or regular expression.
"format": "string" Domain-format name.
}
],
"remote-id": "string", Match remote ID.
"icmpv4-type": "string", Match IPv4 ICMP type.\nShould be value 0..255 or range.
"discard-class": "string", Match discard class.
range: "0..7"
"mpls-disposition-ipv4-access-list": "string", Match MPLS Label Disposition IPv4 access list.
"vpls-control": [ null ], Match VPLS control
"ipv6-precedence": "string" Match IPv6 precedence.
range: "0..7"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
MATCH-NOT - Delete
Delete operation of resource: match-not
ID of type name
Successful operation
Internal Error
Response Content-Types: application/json
MATCH-NOT - Retrieve
Retrieve operation of resource: match-not
ID of type name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "service-name-regex": "string", Match servicve name regular expression.
"protocol": "string", Match protocol.
"vpls-broadcast": [ null ], Match VPLS Broadcast
"precedence": "string", Match precedence.
range: "0..7"
"packet-length": "string", Match packet length.\nShould be value 0..65535 or range.
"fr-de": "integer", Match FrameRelay DE bit.
range: "0..1"
"circuit-id-regex": "string", Match Circuit id regex.
"traffic-class": "string", Match Traffic Class.\nShould be value 0..63 or range.
"ipv6-packet-length": "string", Match IPv6 packet length.\nShould be value 0..65535 or range.
"icmpv6-code": "string", Match IPv6 ICMP code.\nShould be value 0..255 or range.
"timer": "string", Match timer.
"vpls-multicast": [ null ], Match VPLS Multicast
"service-name": "string", Match servicve name.
"fragment-type": "string", Match fragment type for a packet.
"flow-tag": "string", Configure the flow-tag parameters.
"ipv4-packet-length": "string", Match IPv4 packet length.\nShould be value 0..65535 or range. {
"netmask": "string", IPv4 netmask.
"address": "string" IPv4 address.
}
], {
"prefix-length": "integer", IPv6 prefix length.
range: "0..128"
"address": "string" IPv4 address.
}
],
"authen-status": "string", Match authentication status.
"ipv4-precedence": "string", Match IPv4 precedence.
range: "0..7"
"ipv4-dscp": "string", Match IPv4 DSCP.
"tcp-flag": "integer", Match TCP flags.
range: "0..4095"
"ethertype": "string", Match Ethertype.
"mpls-experimental-topmost": "string", Match MPLS experimental topmost label.
range: "0..7"
"ethernet-services-acl": "string", Match Ethernet Services {
"flag": "string", Dhcp client id Ascii/Hex
"value": "string" Dhcp client Id.
}
],
"ipv4-acl": "string", Match IPv4 ACL.
"icmpv6-type": "string", Match IPv6 ICMP type.\nShould be value 0..255 or range.
"vpls-known": [ null ], Match VPLS Known
"destination-port": "string", Match destination port.\nShould be value 0..65535 or range. {
"flag": "string", Dhcp client id Ascii/Hex
"value": "string" Dhcp client Id.
}
],
"inner-cos": "string", Match inner CoS.
range: "0..7"
"frame-relay-dlci": "string", Match frame-relay DLCI value.\nShould be value 16..1007 or range.
"vpls-unknown": [ null ], Match VPLS Unknown
"vlan": "string", Match VLAN ID.
"user-name": "string", Match user name.
"dscp": "string", Match DSCP.
"mpls-experimental-imposition": "string", Match MPLS experimental imposition label.
range: "0..7"
"qos-group": "string", Match QoS group.\nShould be value 0..512 or range.
"source-mac": "string", Match source MAC address.
"circuit-id": "string", Match Circuit ID.
"ipv6-acl": "string", Match IPv6 ACL.
"source-port": "string", Match source port.\nShould be value 0..65535 or range.
"user-name-regex": "string", Match user name regular expression. {
"prefix-length": "integer", IPv6 prefix length.
range: "0..128"
"address": "string" IPv4 address.
}
],
"inner-vlan": "string", Match inner VLAN ID. {
"flow-tag": "integer" Configure the flow-tag parameters.
range: "1..63"
}
],
"cos": "string", Match CoS.
range: "0..7"
"mpls-disposition-ipv6-access-list": "string", Match MPLS Label Disposition IPv6 access list.
"destination-mac": "string", Match destination MAC address.
"dei-inner": "integer", Match DEI INNER bit.
range: "0..1"
"remote-id-regex": "string", Match remote id regex.
"timer-regex": "string", Match timer regular expression. {
"netmask": "string", IPv4 netmask.
"address": "string" IPv4 address.
}
], {
"regex": "string", Domain name or regular expression.
"format": "string" Domain-format name.
}
],
"ipv6-dscp": "string", Match IPv6 DSCP.
"dei": "integer", Match DEI bit.
range: "0..1"
"icmpv4-code": "string", Match IPv4 ICMP code.\nShould be value 0..255 or range. {
"name": "string", Domain name or regular expression.
"format": "string" Domain-format name.
}
],
"remote-id": "string", Match remote ID.
"icmpv4-type": "string", Match IPv4 ICMP type.\nShould be value 0..255 or range.
"discard-class": "string", Match discard class.
range: "0..7"
"mpls-disposition-ipv4-access-list": "string", Match MPLS Label Disposition IPv4 access list.
"vpls-control": [ null ], Match VPLS control
"ipv6-precedence": "string" Match IPv6 precedence.
range: "0..7"
}
}
DESTINATION-ADDRESS-IPV4 - Update
Update operation of resource: destination-address-ipv4
destination-address-ipv4body object
ID of type name
ID of address netmask
Successful operation
Internal Error
Response Content-Types: application/json
DESTINATION-ADDRESS-IPV4 - Create
Create operation of resource: destination-address-ipv4
destination-address-ipv4body object
ID of type name
ID of address netmask
Successful operation
Internal Error
Response Content-Types: application/json
DESTINATION-ADDRESS-IPV4 - Delete
Delete operation of resource: destination-address-ipv4
ID of type name
ID of address netmask
Successful operation
Internal Error
Response Content-Types: application/json
DESTINATION-ADDRESS-IPV4 - Retrieve
Retrieve operation of resource: destination-address-ipv4
ID of type name
ID of address netmask
Successful operation
Internal Error
DESTINATION-ADDRESS-IPV6 - Update
Update operation of resource: destination-address-ipv6
destination-address-ipv6body object
ID of type name
ID of address prefix-length
Successful operation
Internal Error
Response Content-Types: application/json
DESTINATION-ADDRESS-IPV6 - Create
Create operation of resource: destination-address-ipv6
destination-address-ipv6body object
ID of type name
ID of address prefix-length
Successful operation
Internal Error
Response Content-Types: application/json
DESTINATION-ADDRESS-IPV6 - Delete
Delete operation of resource: destination-address-ipv6
ID of type name
ID of address prefix-length
Successful operation
Internal Error
Response Content-Types: application/json
DESTINATION-ADDRESS-IPV6 - Retrieve
Retrieve operation of resource: destination-address-ipv6
ID of type name
ID of address prefix-length
Successful operation
Internal Error
SOURCE-ADDRESS-IPV4 - Update
Update operation of resource: source-address-ipv4
source-address-ipv4body object
ID of type name
ID of address netmask
Successful operation
Internal Error
Response Content-Types: application/json
SOURCE-ADDRESS-IPV4 - Create
Create operation of resource: source-address-ipv4
source-address-ipv4body object
ID of type name
ID of address netmask
Successful operation
Internal Error
Response Content-Types: application/json
SOURCE-ADDRESS-IPV4 - Delete
Delete operation of resource: source-address-ipv4
ID of type name
ID of address netmask
Successful operation
Internal Error
Response Content-Types: application/json
SOURCE-ADDRESS-IPV4 - Retrieve
Retrieve operation of resource: source-address-ipv4
ID of type name
ID of address netmask
Successful operation
Internal Error
SOURCE-ADDRESS-IPV6 - Update
Update operation of resource: source-address-ipv6
source-address-ipv6body object
ID of type name
ID of address prefix-length
Successful operation
Internal Error
Response Content-Types: application/json
SOURCE-ADDRESS-IPV6 - Create
Create operation of resource: source-address-ipv6
source-address-ipv6body object
ID of type name
ID of address prefix-length
Successful operation
Internal Error
Response Content-Types: application/json
SOURCE-ADDRESS-IPV6 - Delete
Delete operation of resource: source-address-ipv6
ID of type name
ID of address prefix-length
Successful operation
Internal Error
Response Content-Types: application/json
SOURCE-ADDRESS-IPV6 - Retrieve
Retrieve operation of resource: source-address-ipv6
ID of type name
ID of address prefix-length
Successful operation
Internal Error
DHCP-CLIENT-ID - Update
Update operation of resource: dhcp-client-id
dhcp-client-idbody object
ID of type name
ID of value flag
Successful operation
Internal Error
Response Content-Types: application/json
DHCP-CLIENT-ID - Create
Create operation of resource: dhcp-client-id
dhcp-client-idbody object
ID of type name
ID of value flag
Successful operation
Internal Error
Response Content-Types: application/json
DHCP-CLIENT-ID - Delete
Delete operation of resource: dhcp-client-id
ID of type name
ID of value flag
Successful operation
Internal Error
Response Content-Types: application/json
DHCP-CLIENT-ID - Retrieve
Retrieve operation of resource: dhcp-client-id
ID of type name
ID of value flag
Successful operation
Internal Error
DHCP-CLIENT-ID-REGEX - Update
Update operation of resource: dhcp-client-id-regex
dhcp-client-id-regexbody object
ID of type name
ID of value flag
Successful operation
Internal Error
Response Content-Types: application/json
DHCP-CLIENT-ID-REGEX - Create
Create operation of resource: dhcp-client-id-regex
dhcp-client-id-regexbody object
ID of type name
ID of value flag
Successful operation
Internal Error
Response Content-Types: application/json
DHCP-CLIENT-ID-REGEX - Delete
Delete operation of resource: dhcp-client-id-regex
ID of type name
ID of value flag
Successful operation
Internal Error
Response Content-Types: application/json
DHCP-CLIENT-ID-REGEX - Retrieve
Retrieve operation of resource: dhcp-client-id-regex
ID of type name
ID of value flag
Successful operation
Internal Error
DOMAIN-NAME - Update
Update operation of resource: domain-name
domain-namebody object
ID of type name
ID of name format
Successful operation
Internal Error
Response Content-Types: application/json
DOMAIN-NAME - Create
Create operation of resource: domain-name
domain-namebody object
ID of type name
ID of name format
Successful operation
Internal Error
Response Content-Types: application/json
DOMAIN-NAME - Delete
Delete operation of resource: domain-name
ID of type name
ID of name format
Successful operation
Internal Error
Response Content-Types: application/json
DOMAIN-NAME - Retrieve
Retrieve operation of resource: domain-name
ID of type name
ID of name format
Successful operation
Internal Error
DOMAIN-NAME-REGEX - Update
Update operation of resource: domain-name-regex
domain-name-regexbody object
ID of type name
ID of regex format
Successful operation
Internal Error
Response Content-Types: application/json
DOMAIN-NAME-REGEX - Create
Create operation of resource: domain-name-regex
domain-name-regexbody object
ID of type name
ID of regex format
Successful operation
Internal Error
Response Content-Types: application/json
DOMAIN-NAME-REGEX - Delete
Delete operation of resource: domain-name-regex
ID of type name
ID of regex format
Successful operation
Internal Error
Response Content-Types: application/json
DOMAIN-NAME-REGEX - Retrieve
Retrieve operation of resource: domain-name-regex
ID of type name
ID of regex format
Successful operation
Internal Error
FLOW - Update
Update operation of resource: flow
flowbody object
ID of type name
Successful operation
Internal Error
Response Content-Types: application/json
FLOW - Create
Create operation of resource: flow
flowbody object
ID of type name
Successful operation
Internal Error
Response Content-Types: application/json
FLOW - Delete
Delete operation of resource: flow
ID of type name
Successful operation
Internal Error
Response Content-Types: application/json
FLOW - Retrieve
Retrieve operation of resource: flow
ID of type name
Successful operation
Internal Error
POLICY-MAPS - Update
Update operation of resource: policy-maps
policy-mapsbody object
Request Content-Types: application/json
Request Example
{ { {
"event-mode-match-all": [ null ], Execute all the matched classes.
"event-type": "enumeration", Event type.
Options:
account-logoff
account-logon
authentication-failure
authentication-no-response
authorization-failure
authorization-no-response
credit-exhausted
exception
idle-timeout
quota-depleted
service-start
service-stop
session-activate
session-start
session-stop
timer-expiry { { "aaa-list": "string", Name of the AAA method list.
"password": "string", Specify a password to be used for AAA\nrequest.
"identifier": "enumeration", Specify an Authorize format name.
Options:
circuit-id
dhcp-client-id
remote-id
source-address-ipv4
source-address-ipv6
source-address-mac
username
"format": "string" Specify an Authorize format name.
}, "aaa-list": "string", Name of the AAA method list.
"name": "string" Name of policy-map.
}, "aaa-list": "string" Name of the AAA method list.
},
"disconnect": [ null ], Disconnect session.
"monitor": [ null ], Monitor session.
"action-sequence-number": "integer", Sequence number for this action.
range: "1..65535" "timer-value": "integer", Timer value in minutes.
units: "minutes"
"timer-name": "string" Name of the timer.
}, "timer-name": "string" Name of the timer.
}, "aaa-list": "string", Name of the AAA method list.
"name": "string" Name of policy-map.
}
}
],
"class-execution-strategy": "enumeration", Class execution strategy.
Options:
do-all
do-until-failure
do-until-success
"class-name": "string", Name of class-map.
"class-type": "enumeration" Type of class-map.
Options:
qos
traffic
subscriber-control
}
],
"event-mode-match-first": [ null ] Execute only the first matched class.
}
], { "unit": "string", Remaining bandwidth units.
"value": "integer" Remaining bandwidth value.
}, "unit": "string", Remaining bandwidth units.
"value": "integer" Remaining bandwidth value.
},
"pfc-pause-set": [ null ], Pfc Pause set value. "unit": "string", Remaining bandwidth units.
"value": "integer" Remaining bandwidth value.
}
}, "index": "integer", ASN2:index 2/4 byte (hex or decimal format)
range: "1..255"
"path-id": "integer", Service function path id.
range: "1..16777215"
"metadata": "string" Service function path metadata name.
},
"default-red": [ null ], Default random early detection
"pbr-transmit": [ null ], Policy action PBR transmit.
"fragment": "string", Policy action fragment. Fragment name "dei": "integer", DEI based WRED.\nShould be value 0..1.
range: "0..1"
"cos": "integer", WRED based on CoS.
range: "0..7"
"inner-cos": "integer", Set inner cos.
range: "0..7"
"forward-class": "integer", Sets the forward class.
range: "0..7"
"precedence": "string", WRED based on precedence.
range: "0..7"
"srp-priority": "integer", Sets the spatial reuse protocol priority value of an\noutgoing packet.
range: "0..7"
"df": "integer", Set DF bit.
range: "0..1"
"fr-de": "integer", Set FrameRelay DE bit.
range: "0..1"
"dscp-tunnel": "string", Marks a packet by setting DSCP in the tunnel header.\nThis is specific to ipsec tunnels
"mpls-experimental-top-most": "integer", Sets the experimental value of the MPLS packet top-most\nlabels.
range: "0..7"
"dscp": "string", WRED based on DSCP.
"mpls-experimental-imposition": "integer", Sets the experimental value of the MPLS packet\nimposition labels.\nImposition can be used only in service policies that\nare attached in the ingress policy
range: "0..7"
"qos-group": "integer", Sets the QoS group identifiers on IPv4 or MPLS packets.\nThe set qos-group is supported only on an ingress policy.
range: "0..512"
"traffic-class": "integer", Sets the Traffic class identifiers on IPv4 or MPLS packets.
range: "0..63"
"destination-address": "string", Destination IPv4 address.
"precedence-tunnel": "string", Sets the precedence tunnel value for ipsec.
range: "0..7"
"source-address": "string", Source IPv4 address.
"discard-class": "integer", WRED based on discard class.
range: "0..7"
"dei-imposition": "integer", Set DEI imposition bit.
range: "0..1"
"atm-clp": [ null ] Set atm cell-loss-priority bit.
}, "index": "integer", ASN2:index 2/4 byte (hex or decimal format)
range: "0..4294967295" "netmask": "string", IPv4 netmask.
"address": "string" IPv4 address.
},
"as-number": "integer" 2-byte/4-byte AS number
range: "1..4294967295"
}
}, "ipv4-next-hop": "string", IPv4 address.
"vrf": "string" VRF name.
}, "ipv6-next-hop": "string", IPv6 address.
"vrf": "string" VRF name.
}
},
"class-name": "string", Name of class-map.
"ecn-red": [ null ], ECN based random early detection "criterion-packet-rate": [ null ], React criterion packet rate.
"criterion-media-stop": [ null ], React criterion media stop.
"criterion-flow-count": [ null ], React criterion flow count. "group-count": "integer", Number of flows to reach before\ntriggering alarm
units: "number of flows"
"discrete": [ null ], Discrete alarm type.
"group-percent": "integer" Percent to reach before triggering alarm
units: "percentage"
},
"severity": "string" Severity of the alarm.
}, "less-than-equal": "string", Less than equal
"range": "string", Range
"greater-than-equal": "string", Greater than equal
"less-than": "string", Less than
"greater-than": "string" Greater than
}, "average": "integer", Trigger averaged over N intervals.
"immediate": [ null ] Immediate trigger.
}
},
"criterion-delay-factor": [ null ], React criterion delay factor.
"descrition": "string", String describing the react statement. "syslog": [ null ], Syslog.
"snmp": [ null ] SNMP.
},
"criterion-mrv": [ null ] React criterion mrv.
}, "unit": "string", Remaining bandwidth units.
"value": "integer" Remaining bandwidth value.
}, "units": "string", Rate units.
"value": "integer" Remaining bandwidth value.
}
},
"pbr-drop": [ null ], Policy action PBR drop.
"priority-level": "integer", Priority level.
range: "1..7"
"service-fragment": "string", Policy action service fragment.\nService fragment name "unit": "string", Remaining bandwidth units.
"value": "integer" Remaining bandwidth value.
}, "Transmit": [ null ], Police action transmit.
"drop": [ null ], Police action drop. "dei": "integer", DEI based WRED.\nShould be value 0..1.
range: "0..1"
"cos": "integer", WRED based on CoS.
range: "0..7"
"inner-cos": "integer", Set inner cos.
range: "0..7"
"forward-class": "integer", Sets the forward class.
range: "0..7"
"precedence": "string", WRED based on precedence.
range: "0..7"
"srp-priority": "integer", Sets the spatial reuse protocol priority value of an\noutgoing packet.
range: "0..7"
"df": "integer", Set DF bit.
range: "0..1"
"fr-de": "integer", Set FrameRelay DE bit.
range: "0..1"
"dscp-tunnel": "string", Marks a packet by setting DSCP in the tunnel header.\nThis is specific to ipsec tunnels
"mpls-experimental-top-most": "integer", Sets the experimental value of the MPLS packet top-most\nlabels.
range: "0..7"
"dscp": "string", WRED based on DSCP.
"mpls-experimental-imposition": "integer", Sets the experimental value of the MPLS packet\nimposition labels.\nImposition can be used only in service policies that\nare attached in the ingress policy
range: "0..7"
"qos-group": "integer", Sets the QoS group identifiers on IPv4 or MPLS packets.\nThe set qos-group is supported only on an ingress policy.
range: "0..512"
"traffic-class": "integer", Sets the Traffic class identifiers on IPv4 or MPLS packets.
range: "0..63"
"destination-address": "string", Destination IPv4 address.
"precedence-tunnel": "string", Sets the precedence tunnel value for ipsec.
range: "0..7"
"source-address": "string", Source IPv4 address.
"discard-class": "integer", WRED based on discard class.
range: "0..7"
"dei-imposition": "integer", Set DEI imposition bit.
range: "0..1"
"atm-clp": [ null ] Set atm cell-loss-priority bit.
}
}, "units": "string", Rate units.
"value": "integer" Remaining bandwidth value.
}, "units": "string", Rate units.
"value": "integer" Remaining bandwidth value.
}, "units": "string", Rate units.
"value": "integer" Remaining bandwidth value.
}, "Transmit": [ null ], Police action transmit.
"drop": [ null ], Police action drop. "dei": "integer", DEI based WRED.\nShould be value 0..1.
range: "0..1"
"cos": "integer", WRED based on CoS.
range: "0..7"
"inner-cos": "integer", Set inner cos.
range: "0..7"
"forward-class": "integer", Sets the forward class.
range: "0..7"
"precedence": "string", WRED based on precedence.
range: "0..7"
"srp-priority": "integer", Sets the spatial reuse protocol priority value of an\noutgoing packet.
range: "0..7"
"df": "integer", Set DF bit.
range: "0..1"
"fr-de": "integer", Set FrameRelay DE bit.
range: "0..1"
"dscp-tunnel": "string", Marks a packet by setting DSCP in the tunnel header.\nThis is specific to ipsec tunnels
"mpls-experimental-top-most": "integer", Sets the experimental value of the MPLS packet top-most\nlabels.
range: "0..7"
"dscp": "string", WRED based on DSCP.
"mpls-experimental-imposition": "integer", Sets the experimental value of the MPLS packet\nimposition labels.\nImposition can be used only in service policies that\nare attached in the ingress policy
range: "0..7"
"qos-group": "integer", Sets the QoS group identifiers on IPv4 or MPLS packets.\nThe set qos-group is supported only on an ingress policy.
range: "0..512"
"traffic-class": "integer", Sets the Traffic class identifiers on IPv4 or MPLS packets.
range: "0..63"
"destination-address": "string", Destination IPv4 address.
"precedence-tunnel": "string", Sets the precedence tunnel value for ipsec.
range: "0..7"
"source-address": "string", Source IPv4 address.
"discard-class": "integer", WRED based on discard class.
range: "0..7"
"dei-imposition": "integer", Set DEI imposition bit.
range: "0..1"
"atm-clp": [ null ] Set atm cell-loss-priority bit.
}
}, "units": "string", Rate units.
"value": "integer" Remaining bandwidth value.
}, "Transmit": [ null ], Police action transmit.
"drop": [ null ], Police action drop. "dei": "integer", DEI based WRED.\nShould be value 0..1.
range: "0..1"
"cos": "integer", WRED based on CoS.
range: "0..7"
"inner-cos": "integer", Set inner cos.
range: "0..7"
"forward-class": "integer", Sets the forward class.
range: "0..7"
"precedence": "string", WRED based on precedence.
range: "0..7"
"srp-priority": "integer", Sets the spatial reuse protocol priority value of an\noutgoing packet.
range: "0..7"
"df": "integer", Set DF bit.
range: "0..1"
"fr-de": "integer", Set FrameRelay DE bit.
range: "0..1"
"dscp-tunnel": "string", Marks a packet by setting DSCP in the tunnel header.\nThis is specific to ipsec tunnels
"mpls-experimental-top-most": "integer", Sets the experimental value of the MPLS packet top-most\nlabels.
range: "0..7"
"dscp": "string", WRED based on DSCP.
"mpls-experimental-imposition": "integer", Sets the experimental value of the MPLS packet\nimposition labels.\nImposition can be used only in service policies that\nare attached in the ingress policy
range: "0..7"
"qos-group": "integer", Sets the QoS group identifiers on IPv4 or MPLS packets.\nThe set qos-group is supported only on an ingress policy.
range: "0..512"
"traffic-class": "integer", Sets the Traffic class identifiers on IPv4 or MPLS packets.
range: "0..63"
"destination-address": "string", Destination IPv4 address.
"precedence-tunnel": "string", Sets the precedence tunnel value for ipsec.
range: "0..7"
"source-address": "string", Source IPv4 address.
"discard-class": "integer", WRED based on discard class.
range: "0..7"
"dei-imposition": "integer", Set DEI imposition bit.
range: "0..1"
"atm-clp": [ null ] Set atm cell-loss-priority bit.
}
}
}, "subscriberip": [ null ], Subscriber IP
"hostname": [ null ], Hostname
"subscribermac": [ null ], Subscriber Mac
"bngidentifierinterface": [ null ] Bng Identifier Interface
}, "layer3": "integer", Nominal rate specified at the L3 (IP).
units: "bps"
"media": "integer", Nominal data rate of the media flow (ip payload).
range: "1..3000000000"
units: "bps"
"packet": "integer" Nominal IP layer packet rate (in pps).
units: "pps"
}, "count-in-layer3": "integer", Nominal number of media packets in an IP payload.
range: "1..64"
units: "packets"
"size": "integer" Nominal size of the media-packet.
units: "bytes"
}
}, "flow-idle-timeout": "string", The interval after which a flow is removed,\nif there is no activity.\nIf timeout is 0 this flow does not expire. "units": "string", Rate units.
"value": "integer" Remaining bandwidth value.
range: "1..4294967295"
}, "units": "string", Rate units.
"value": "integer" Remaining bandwidth value.
range: "1..4294967295"
}
}, "unit": "string", Remaining bandwidth units.
"value": "integer" Remaining bandwidth value.
},
"http-redirect": "string", Policy action http redirect.\nRedirect to this url. "default": [ null ], Use system default routing table. : { "ipv6-address": "string", IPv6 address.
"ipv4-address": "string", IPv4 address.
"vrf": "string" VRF name.
}
}, "max-flow": "integer", Max simultaneous flows monitored per policy class
range: "0..4096"
"interval-duration": "integer", Monitored interval duration.
units: "seconds"
"timeout": "integer", Declare a flow dead if no packets received in\nso much time
units: "seconds"
"history": "integer" Keep stats/metrics on box for so many intervals.
},
"class-type": "enumeration", Type of class-map.
Options:
qos
traffic
subscriber-control "policy-name": "string", Name of service-policy.
"type": "string" Type of policy-map.
}, "unit": "string", Remaining bandwidth units.
"value": "integer" Remaining bandwidth value.
},
"decap-gre": [ null ], Policy action DECAP GRE. {
"cos": "string", WRED based on CoS.
range: "0..7"
"threshold-max-value": "integer", Maximum RED threshold value.
"precedence": "string", WRED based on precedence.
range: "0..7"
"threshold-min-value": "integer", Minimum RED threshold value.
"threshold-max-units": "string", Maximum RED threshold units.
"dscp": "string", WRED based on DSCP.
"dei": "integer", DEI based WRED.\nShould be value 0..1.
range: "0..1"
"threshold-min-units": "string", Minimum RED threshold units.
"ecn": [ null ], ECN based WRED.
"discard-class": "string", WRED based on discard class.
range: "0..7"
"mpls-exp": "string" MPLS Experimental value based WRED.
range: "0..7"
}
]
}
],
"type": "enumeration", Type of policy-map.
Options:
qos
pbr
traffic
subscriber-control
accounting
redirect
flow-monitor
"description": "string", Description for this policy-map.
"name": "string" Name of policy-map.
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
POLICY-MAPS - Create
Create operation of resource: policy-maps
policy-mapsbody object
Request Content-Types: application/json
Request Example
{ { {
"event-mode-match-all": [ null ], Execute all the matched classes.
"event-type": "enumeration", Event type.
Options:
account-logoff
account-logon
authentication-failure
authentication-no-response
authorization-failure
authorization-no-response
credit-exhausted
exception
idle-timeout
quota-depleted
service-start
service-stop
session-activate
session-start
session-stop
timer-expiry { { "aaa-list": "string", Name of the AAA method list.
"password": "string", Specify a password to be used for AAA\nrequest.
"identifier": "enumeration", Specify an Authorize format name.
Options:
circuit-id
dhcp-client-id
remote-id
source-address-ipv4
source-address-ipv6
source-address-mac
username
"format": "string" Specify an Authorize format name.
}, "aaa-list": "string", Name of the AAA method list.
"name": "string" Name of policy-map.
}, "aaa-list": "string" Name of the AAA method list.
},
"disconnect": [ null ], Disconnect session.
"monitor": [ null ], Monitor session.
"action-sequence-number": "integer", Sequence number for this action.
range: "1..65535" "timer-value": "integer", Timer value in minutes.
units: "minutes"
"timer-name": "string" Name of the timer.
}, "timer-name": "string" Name of the timer.
}, "aaa-list": "string", Name of the AAA method list.
"name": "string" Name of policy-map.
}
}
],
"class-execution-strategy": "enumeration", Class execution strategy.
Options:
do-all
do-until-failure
do-until-success
"class-name": "string", Name of class-map.
"class-type": "enumeration" Type of class-map.
Options:
qos
traffic
subscriber-control
}
],
"event-mode-match-first": [ null ] Execute only the first matched class.
}
], { "unit": "string", Remaining bandwidth units.
"value": "integer" Remaining bandwidth value.
}, "unit": "string", Remaining bandwidth units.
"value": "integer" Remaining bandwidth value.
},
"pfc-pause-set": [ null ], Pfc Pause set value. "unit": "string", Remaining bandwidth units.
"value": "integer" Remaining bandwidth value.
}
}, "index": "integer", ASN2:index 2/4 byte (hex or decimal format)
range: "1..255"
"path-id": "integer", Service function path id.
range: "1..16777215"
"metadata": "string" Service function path metadata name.
},
"default-red": [ null ], Default random early detection
"pbr-transmit": [ null ], Policy action PBR transmit.
"fragment": "string", Policy action fragment. Fragment name "dei": "integer", DEI based WRED.\nShould be value 0..1.
range: "0..1"
"cos": "integer", WRED based on CoS.
range: "0..7"
"inner-cos": "integer", Set inner cos.
range: "0..7"
"forward-class": "integer", Sets the forward class.
range: "0..7"
"precedence": "string", WRED based on precedence.
range: "0..7"
"srp-priority": "integer", Sets the spatial reuse protocol priority value of an\noutgoing packet.
range: "0..7"
"df": "integer", Set DF bit.
range: "0..1"
"fr-de": "integer", Set FrameRelay DE bit.
range: "0..1"
"dscp-tunnel": "string", Marks a packet by setting DSCP in the tunnel header.\nThis is specific to ipsec tunnels
"mpls-experimental-top-most": "integer", Sets the experimental value of the MPLS packet top-most\nlabels.
range: "0..7"
"dscp": "string", WRED based on DSCP.
"mpls-experimental-imposition": "integer", Sets the experimental value of the MPLS packet\nimposition labels.\nImposition can be used only in service policies that\nare attached in the ingress policy
range: "0..7"
"qos-group": "integer", Sets the QoS group identifiers on IPv4 or MPLS packets.\nThe set qos-group is supported only on an ingress policy.
range: "0..512"
"traffic-class": "integer", Sets the Traffic class identifiers on IPv4 or MPLS packets.
range: "0..63"
"destination-address": "string", Destination IPv4 address.
"precedence-tunnel": "string", Sets the precedence tunnel value for ipsec.
range: "0..7"
"source-address": "string", Source IPv4 address.
"discard-class": "integer", WRED based on discard class.
range: "0..7"
"dei-imposition": "integer", Set DEI imposition bit.
range: "0..1"
"atm-clp": [ null ] Set atm cell-loss-priority bit.
}, "index": "integer", ASN2:index 2/4 byte (hex or decimal format)
range: "0..4294967295" "netmask": "string", IPv4 netmask.
"address": "string" IPv4 address.
},
"as-number": "integer" 2-byte/4-byte AS number
range: "1..4294967295"
}
}, "ipv4-next-hop": "string", IPv4 address.
"vrf": "string" VRF name.
}, "ipv6-next-hop": "string", IPv6 address.
"vrf": "string" VRF name.
}
},
"class-name": "string", Name of class-map.
"ecn-red": [ null ], ECN based random early detection "criterion-packet-rate": [ null ], React criterion packet rate.
"criterion-media-stop": [ null ], React criterion media stop.
"criterion-flow-count": [ null ], React criterion flow count. "group-count": "integer", Number of flows to reach before\ntriggering alarm
units: "number of flows"
"discrete": [ null ], Discrete alarm type.
"group-percent": "integer" Percent to reach before triggering alarm
units: "percentage"
},
"severity": "string" Severity of the alarm.
}, "less-than-equal": "string", Less than equal
"range": "string", Range
"greater-than-equal": "string", Greater than equal
"less-than": "string", Less than
"greater-than": "string" Greater than
}, "average": "integer", Trigger averaged over N intervals.
"immediate": [ null ] Immediate trigger.
}
},
"criterion-delay-factor": [ null ], React criterion delay factor.
"descrition": "string", String describing the react statement. "syslog": [ null ], Syslog.
"snmp": [ null ] SNMP.
},
"criterion-mrv": [ null ] React criterion mrv.
}, "unit": "string", Remaining bandwidth units.
"value": "integer" Remaining bandwidth value.
}, "units": "string", Rate units.
"value": "integer" Remaining bandwidth value.
}
},
"pbr-drop": [ null ], Policy action PBR drop.
"priority-level": "integer", Priority level.
range: "1..7"
"service-fragment": "string", Policy action service fragment.\nService fragment name "unit": "string", Remaining bandwidth units.
"value": "integer" Remaining bandwidth value.
}, "Transmit": [ null ], Police action transmit.
"drop": [ null ], Police action drop. "dei": "integer", DEI based WRED.\nShould be value 0..1.
range: "0..1"
"cos": "integer", WRED based on CoS.
range: "0..7"
"inner-cos": "integer", Set inner cos.
range: "0..7"
"forward-class": "integer", Sets the forward class.
range: "0..7"
"precedence": "string", WRED based on precedence.
range: "0..7"
"srp-priority": "integer", Sets the spatial reuse protocol priority value of an\noutgoing packet.
range: "0..7"
"df": "integer", Set DF bit.
range: "0..1"
"fr-de": "integer", Set FrameRelay DE bit.
range: "0..1"
"dscp-tunnel": "string", Marks a packet by setting DSCP in the tunnel header.\nThis is specific to ipsec tunnels
"mpls-experimental-top-most": "integer", Sets the experimental value of the MPLS packet top-most\nlabels.
range: "0..7"
"dscp": "string", WRED based on DSCP.
"mpls-experimental-imposition": "integer", Sets the experimental value of the MPLS packet\nimposition labels.\nImposition can be used only in service policies that\nare attached in the ingress policy
range: "0..7"
"qos-group": "integer", Sets the QoS group identifiers on IPv4 or MPLS packets.\nThe set qos-group is supported only on an ingress policy.
range: "0..512"
"traffic-class": "integer", Sets the Traffic class identifiers on IPv4 or MPLS packets.
range: "0..63"
"destination-address": "string", Destination IPv4 address.
"precedence-tunnel": "string", Sets the precedence tunnel value for ipsec.
range: "0..7"
"source-address": "string", Source IPv4 address.
"discard-class": "integer", WRED based on discard class.
range: "0..7"
"dei-imposition": "integer", Set DEI imposition bit.
range: "0..1"
"atm-clp": [ null ] Set atm cell-loss-priority bit.
}
}, "units": "string", Rate units.
"value": "integer" Remaining bandwidth value.
}, "units": "string", Rate units.
"value": "integer" Remaining bandwidth value.
}, "units": "string", Rate units.
"value": "integer" Remaining bandwidth value.
}, "Transmit": [ null ], Police action transmit.
"drop": [ null ], Police action drop. "dei": "integer", DEI based WRED.\nShould be value 0..1.
range: "0..1"
"cos": "integer", WRED based on CoS.
range: "0..7"
"inner-cos": "integer", Set inner cos.
range: "0..7"
"forward-class": "integer", Sets the forward class.
range: "0..7"
"precedence": "string", WRED based on precedence.
range: "0..7"
"srp-priority": "integer", Sets the spatial reuse protocol priority value of an\noutgoing packet.
range: "0..7"
"df": "integer", Set DF bit.
range: "0..1"
"fr-de": "integer", Set FrameRelay DE bit.
range: "0..1"
"dscp-tunnel": "string", Marks a packet by setting DSCP in the tunnel header.\nThis is specific to ipsec tunnels
"mpls-experimental-top-most": "integer", Sets the experimental value of the MPLS packet top-most\nlabels.
range: "0..7"
"dscp": "string", WRED based on DSCP.
"mpls-experimental-imposition": "integer", Sets the experimental value of the MPLS packet\nimposition labels.\nImposition can be used only in service policies that\nare attached in the ingress policy
range: "0..7"
"qos-group": "integer", Sets the QoS group identifiers on IPv4 or MPLS packets.\nThe set qos-group is supported only on an ingress policy.
range: "0..512"
"traffic-class": "integer", Sets the Traffic class identifiers on IPv4 or MPLS packets.
range: "0..63"
"destination-address": "string", Destination IPv4 address.
"precedence-tunnel": "string", Sets the precedence tunnel value for ipsec.
range: "0..7"
"source-address": "string", Source IPv4 address.
"discard-class": "integer", WRED based on discard class.
range: "0..7"
"dei-imposition": "integer", Set DEI imposition bit.
range: "0..1"
"atm-clp": [ null ] Set atm cell-loss-priority bit.
}
}, "units": "string", Rate units.
"value": "integer" Remaining bandwidth value.
}, "Transmit": [ null ], Police action transmit.
"drop": [ null ], Police action drop. "dei": "integer", DEI based WRED.\nShould be value 0..1.
range: "0..1"
"cos": "integer", WRED based on CoS.
range: "0..7"
"inner-cos": "integer", Set inner cos.
range: "0..7"
"forward-class": "integer", Sets the forward class.
range: "0..7"
"precedence": "string", WRED based on precedence.
range: "0..7"
"srp-priority": "integer", Sets the spatial reuse protocol priority value of an\noutgoing packet.
range: "0..7"
"df": "integer", Set DF bit.
range: "0..1"
"fr-de": "integer", Set FrameRelay DE bit.
range: "0..1"
"dscp-tunnel": "string", Marks a packet by setting DSCP in the tunnel header.\nThis is specific to ipsec tunnels
"mpls-experimental-top-most": "integer", Sets the experimental value of the MPLS packet top-most\nlabels.
range: "0..7"
"dscp": "string", WRED based on DSCP.
"mpls-experimental-imposition": "integer", Sets the experimental value of the MPLS packet\nimposition labels.\nImposition can be used only in service policies that\nare attached in the ingress policy
range: "0..7"
"qos-group": "integer", Sets the QoS group identifiers on IPv4 or MPLS packets.\nThe set qos-group is supported only on an ingress policy.
range: "0..512"
"traffic-class": "integer", Sets the Traffic class identifiers on IPv4 or MPLS packets.
range: "0..63"
"destination-address": "string", Destination IPv4 address.
"precedence-tunnel": "string", Sets the precedence tunnel value for ipsec.
range: "0..7"
"source-address": "string", Source IPv4 address.
"discard-class": "integer", WRED based on discard class.
range: "0..7"
"dei-imposition": "integer", Set DEI imposition bit.
range: "0..1"
"atm-clp": [ null ] Set atm cell-loss-priority bit.
}
}
}, "subscriberip": [ null ], Subscriber IP
"hostname": [ null ], Hostname
"subscribermac": [ null ], Subscriber Mac
"bngidentifierinterface": [ null ] Bng Identifier Interface
}, "layer3": "integer", Nominal rate specified at the L3 (IP).
units: "bps"
"media": "integer", Nominal data rate of the media flow (ip payload).
range: "1..3000000000"
units: "bps"
"packet": "integer" Nominal IP layer packet rate (in pps).
units: "pps"
}, "count-in-layer3": "integer", Nominal number of media packets in an IP payload.
range: "1..64"
units: "packets"
"size": "integer" Nominal size of the media-packet.
units: "bytes"
}
}, "flow-idle-timeout": "string", The interval after which a flow is removed,\nif there is no activity.\nIf timeout is 0 this flow does not expire. "units": "string", Rate units.
"value": "integer" Remaining bandwidth value.
range: "1..4294967295"
}, "units": "string", Rate units.
"value": "integer" Remaining bandwidth value.
range: "1..4294967295"
}
}, "unit": "string", Remaining bandwidth units.
"value": "integer" Remaining bandwidth value.
},
"http-redirect": "string", Policy action http redirect.\nRedirect to this url. "default": [ null ], Use system default routing table. : { "ipv6-address": "string", IPv6 address.
"ipv4-address": "string", IPv4 address.
"vrf": "string" VRF name.
}
}, "max-flow": "integer", Max simultaneous flows monitored per policy class
range: "0..4096"
"interval-duration": "integer", Monitored interval duration.
units: "seconds"
"timeout": "integer", Declare a flow dead if no packets received in\nso much time
units: "seconds"
"history": "integer" Keep stats/metrics on box for so many intervals.
},
"class-type": "enumeration", Type of class-map.
Options:
qos
traffic
subscriber-control "policy-name": "string", Name of service-policy.
"type": "string" Type of policy-map.
}, "unit": "string", Remaining bandwidth units.
"value": "integer" Remaining bandwidth value.
},
"decap-gre": [ null ], Policy action DECAP GRE. {
"cos": "string", WRED based on CoS.
range: "0..7"
"threshold-max-value": "integer", Maximum RED threshold value.
"precedence": "string", WRED based on precedence.
range: "0..7"
"threshold-min-value": "integer", Minimum RED threshold value.
"threshold-max-units": "string", Maximum RED threshold units.
"dscp": "string", WRED based on DSCP.
"dei": "integer", DEI based WRED.\nShould be value 0..1.
range: "0..1"
"threshold-min-units": "string", Minimum RED threshold units.
"ecn": [ null ], ECN based WRED.
"discard-class": "string", WRED based on discard class.
range: "0..7"
"mpls-exp": "string" MPLS Experimental value based WRED.
range: "0..7"
}
]
}
],
"type": "enumeration", Type of policy-map.
Options:
qos
pbr
traffic
subscriber-control
accounting
redirect
flow-monitor
"description": "string", Description for this policy-map.
"name": "string" Name of policy-map.
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
POLICY-MAPS - Delete
Delete operation of resource: policy-maps
Successful operation
Internal Error
Response Content-Types: application/json
POLICY-MAPS - Retrieve
Retrieve operation of resource: policy-maps
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { {
"event-mode-match-all": [ null ], Execute all the matched classes.
"event-type": "enumeration", Event type.
Options:
account-logoff
account-logon
authentication-failure
authentication-no-response
authorization-failure
authorization-no-response
credit-exhausted
exception
idle-timeout
quota-depleted
service-start
service-stop
session-activate
session-start
session-stop
timer-expiry { { "aaa-list": "string", Name of the AAA method list.
"password": "string", Specify a password to be used for AAA\nrequest.
"identifier": "enumeration", Specify an Authorize format name.
Options:
circuit-id
dhcp-client-id
remote-id
source-address-ipv4
source-address-ipv6
source-address-mac
username
"format": "string" Specify an Authorize format name.
}, "aaa-list": "string", Name of the AAA method list.
"name": "string" Name of policy-map.
}, "aaa-list": "string" Name of the AAA method list.
},
"disconnect": [ null ], Disconnect session.
"monitor": [ null ], Monitor session.
"action-sequence-number": "integer", Sequence number for this action.
range: "1..65535" "timer-value": "integer", Timer value in minutes.
units: "minutes"
"timer-name": "string" Name of the timer.
}, "timer-name": "string" Name of the timer.
}, "aaa-list": "string", Name of the AAA method list.
"name": "string" Name of policy-map.
}
}
],
"class-execution-strategy": "enumeration", Class execution strategy.
Options:
do-all
do-until-failure
do-until-success
"class-name": "string", Name of class-map.
"class-type": "enumeration" Type of class-map.
Options:
qos
traffic
subscriber-control
}
],
"event-mode-match-first": [ null ] Execute only the first matched class.
}
], { "unit": "string", Remaining bandwidth units.
"value": "integer" Remaining bandwidth value.
}, "unit": "string", Remaining bandwidth units.
"value": "integer" Remaining bandwidth value.
},
"pfc-pause-set": [ null ], Pfc Pause set value. "unit": "string", Remaining bandwidth units.
"value": "integer" Remaining bandwidth value.
}
}, "index": "integer", ASN2:index 2/4 byte (hex or decimal format)
range: "1..255"
"path-id": "integer", Service function path id.
range: "1..16777215"
"metadata": "string" Service function path metadata name.
},
"default-red": [ null ], Default random early detection
"pbr-transmit": [ null ], Policy action PBR transmit.
"fragment": "string", Policy action fragment. Fragment name "dei": "integer", DEI based WRED.\nShould be value 0..1.
range: "0..1"
"cos": "integer", WRED based on CoS.
range: "0..7"
"inner-cos": "integer", Set inner cos.
range: "0..7"
"forward-class": "integer", Sets the forward class.
range: "0..7"
"precedence": "string", WRED based on precedence.
range: "0..7"
"srp-priority": "integer", Sets the spatial reuse protocol priority value of an\noutgoing packet.
range: "0..7"
"df": "integer", Set DF bit.
range: "0..1"
"fr-de": "integer", Set FrameRelay DE bit.
range: "0..1"
"dscp-tunnel": "string", Marks a packet by setting DSCP in the tunnel header.\nThis is specific to ipsec tunnels
"mpls-experimental-top-most": "integer", Sets the experimental value of the MPLS packet top-most\nlabels.
range: "0..7"
"dscp": "string", WRED based on DSCP.
"mpls-experimental-imposition": "integer", Sets the experimental value of the MPLS packet\nimposition labels.\nImposition can be used only in service policies that\nare attached in the ingress policy
range: "0..7"
"qos-group": "integer", Sets the QoS group identifiers on IPv4 or MPLS packets.\nThe set qos-group is supported only on an ingress policy.
range: "0..512"
"traffic-class": "integer", Sets the Traffic class identifiers on IPv4 or MPLS packets.
range: "0..63"
"destination-address": "string", Destination IPv4 address.
"precedence-tunnel": "string", Sets the precedence tunnel value for ipsec.
range: "0..7"
"source-address": "string", Source IPv4 address.
"discard-class": "integer", WRED based on discard class.
range: "0..7"
"dei-imposition": "integer", Set DEI imposition bit.
range: "0..1"
"atm-clp": [ null ] Set atm cell-loss-priority bit.
}, "index": "integer", ASN2:index 2/4 byte (hex or decimal format)
range: "0..4294967295" "netmask": "string", IPv4 netmask.
"address": "string" IPv4 address.
},
"as-number": "integer" 2-byte/4-byte AS number
range: "1..4294967295"
}
}, "ipv4-next-hop": "string", IPv4 address.
"vrf": "string" VRF name.
}, "ipv6-next-hop": "string", IPv6 address.
"vrf": "string" VRF name.
}
},
"class-name": "string", Name of class-map.
"ecn-red": [ null ], ECN based random early detection "criterion-packet-rate": [ null ], React criterion packet rate.
"criterion-media-stop": [ null ], React criterion media stop.
"criterion-flow-count": [ null ], React criterion flow count. "group-count": "integer", Number of flows to reach before\ntriggering alarm
units: "number of flows"
"discrete": [ null ], Discrete alarm type.
"group-percent": "integer" Percent to reach before triggering alarm
units: "percentage"
},
"severity": "string" Severity of the alarm.
}, "less-than-equal": "string", Less than equal
"range": "string", Range
"greater-than-equal": "string", Greater than equal
"less-than": "string", Less than
"greater-than": "string" Greater than
}, "average": "integer", Trigger averaged over N intervals.
"immediate": [ null ] Immediate trigger.
}
},
"criterion-delay-factor": [ null ], React criterion delay factor.
"descrition": "string", String describing the react statement. "syslog": [ null ], Syslog.
"snmp": [ null ] SNMP.
},
"criterion-mrv": [ null ] React criterion mrv.
}, "unit": "string", Remaining bandwidth units.
"value": "integer" Remaining bandwidth value.
}, "units": "string", Rate units.
"value": "integer" Remaining bandwidth value.
}
},
"pbr-drop": [ null ], Policy action PBR drop.
"priority-level": "integer", Priority level.
range: "1..7"
"service-fragment": "string", Policy action service fragment.\nService fragment name "unit": "string", Remaining bandwidth units.
"value": "integer" Remaining bandwidth value.
}, "Transmit": [ null ], Police action transmit.
"drop": [ null ], Police action drop. "dei": "integer", DEI based WRED.\nShould be value 0..1.
range: "0..1"
"cos": "integer", WRED based on CoS.
range: "0..7"
"inner-cos": "integer", Set inner cos.
range: "0..7"
"forward-class": "integer", Sets the forward class.
range: "0..7"
"precedence": "string", WRED based on precedence.
range: "0..7"
"srp-priority": "integer", Sets the spatial reuse protocol priority value of an\noutgoing packet.
range: "0..7"
"df": "integer", Set DF bit.
range: "0..1"
"fr-de": "integer", Set FrameRelay DE bit.
range: "0..1"
"dscp-tunnel": "string", Marks a packet by setting DSCP in the tunnel header.\nThis is specific to ipsec tunnels
"mpls-experimental-top-most": "integer", Sets the experimental value of the MPLS packet top-most\nlabels.
range: "0..7"
"dscp": "string", WRED based on DSCP.
"mpls-experimental-imposition": "integer", Sets the experimental value of the MPLS packet\nimposition labels.\nImposition can be used only in service policies that\nare attached in the ingress policy
range: "0..7"
"qos-group": "integer", Sets the QoS group identifiers on IPv4 or MPLS packets.\nThe set qos-group is supported only on an ingress policy.
range: "0..512"
"traffic-class": "integer", Sets the Traffic class identifiers on IPv4 or MPLS packets.
range: "0..63"
"destination-address": "string", Destination IPv4 address.
"precedence-tunnel": "string", Sets the precedence tunnel value for ipsec.
range: "0..7"
"source-address": "string", Source IPv4 address.
"discard-class": "integer", WRED based on discard class.
range: "0..7"
"dei-imposition": "integer", Set DEI imposition bit.
range: "0..1"
"atm-clp": [ null ] Set atm cell-loss-priority bit.
}
}, "units": "string", Rate units.
"value": "integer" Remaining bandwidth value.
}, "units": "string", Rate units.
"value": "integer" Remaining bandwidth value.
}, "units": "string", Rate units.
"value": "integer" Remaining bandwidth value.
}, "Transmit": [ null ], Police action transmit.
"drop": [ null ], Police action drop. "dei": "integer", DEI based WRED.\nShould be value 0..1.
range: "0..1"
"cos": "integer", WRED based on CoS.
range: "0..7"
"inner-cos": "integer", Set inner cos.
range: "0..7"
"forward-class": "integer", Sets the forward class.
range: "0..7"
"precedence": "string", WRED based on precedence.
range: "0..7"
"srp-priority": "integer", Sets the spatial reuse protocol priority value of an\noutgoing packet.
range: "0..7"
"df": "integer", Set DF bit.
range: "0..1"
"fr-de": "integer", Set FrameRelay DE bit.
range: "0..1"
"dscp-tunnel": "string", Marks a packet by setting DSCP in the tunnel header.\nThis is specific to ipsec tunnels
"mpls-experimental-top-most": "integer", Sets the experimental value of the MPLS packet top-most\nlabels.
range: "0..7"
"dscp": "string", WRED based on DSCP.
"mpls-experimental-imposition": "integer", Sets the experimental value of the MPLS packet\nimposition labels.\nImposition can be used only in service policies that\nare attached in the ingress policy
range: "0..7"
"qos-group": "integer", Sets the QoS group identifiers on IPv4 or MPLS packets.\nThe set qos-group is supported only on an ingress policy.
range: "0..512"
"traffic-class": "integer", Sets the Traffic class identifiers on IPv4 or MPLS packets.
range: "0..63"
"destination-address": "string", Destination IPv4 address.
"precedence-tunnel": "string", Sets the precedence tunnel value for ipsec.
range: "0..7"
"source-address": "string", Source IPv4 address.
"discard-class": "integer", WRED based on discard class.
range: "0..7"
"dei-imposition": "integer", Set DEI imposition bit.
range: "0..1"
"atm-clp": [ null ] Set atm cell-loss-priority bit.
}
}, "units": "string", Rate units.
"value": "integer" Remaining bandwidth value.
}, "Transmit": [ null ], Police action transmit.
"drop": [ null ], Police action drop. "dei": "integer", DEI based WRED.\nShould be value 0..1.
range: "0..1"
"cos": "integer", WRED based on CoS.
range: "0..7"
"inner-cos": "integer", Set inner cos.
range: "0..7"
"forward-class": "integer", Sets the forward class.
range: "0..7"
"precedence": "string", WRED based on precedence.
range: "0..7"
"srp-priority": "integer", Sets the spatial reuse protocol priority value of an\noutgoing packet.
range: "0..7"
"df": "integer", Set DF bit.
range: "0..1"
"fr-de": "integer", Set FrameRelay DE bit.
range: "0..1"
"dscp-tunnel": "string", Marks a packet by setting DSCP in the tunnel header.\nThis is specific to ipsec tunnels
"mpls-experimental-top-most": "integer", Sets the experimental value of the MPLS packet top-most\nlabels.
range: "0..7"
"dscp": "string", WRED based on DSCP.
"mpls-experimental-imposition": "integer", Sets the experimental value of the MPLS packet\nimposition labels.\nImposition can be used only in service policies that\nare attached in the ingress policy
range: "0..7"
"qos-group": "integer", Sets the QoS group identifiers on IPv4 or MPLS packets.\nThe set qos-group is supported only on an ingress policy.
range: "0..512"
"traffic-class": "integer", Sets the Traffic class identifiers on IPv4 or MPLS packets.
range: "0..63"
"destination-address": "string", Destination IPv4 address.
"precedence-tunnel": "string", Sets the precedence tunnel value for ipsec.
range: "0..7"
"source-address": "string", Source IPv4 address.
"discard-class": "integer", WRED based on discard class.
range: "0..7"
"dei-imposition": "integer", Set DEI imposition bit.
range: "0..1"
"atm-clp": [ null ] Set atm cell-loss-priority bit.
}
}
}, "subscriberip": [ null ], Subscriber IP
"hostname": [ null ], Hostname
"subscribermac": [ null ], Subscriber Mac
"bngidentifierinterface": [ null ] Bng Identifier Interface
}, "layer3": "integer", Nominal rate specified at the L3 (IP).
units: "bps"
"media": "integer", Nominal data rate of the media flow (ip payload).
range: "1..3000000000"
units: "bps"
"packet": "integer" Nominal IP layer packet rate (in pps).
units: "pps"
}, "count-in-layer3": "integer", Nominal number of media packets in an IP payload.
range: "1..64"
units: "packets"
"size": "integer" Nominal size of the media-packet.
units: "bytes"
}
}, "flow-idle-timeout": "string", The interval after which a flow is removed,\nif there is no activity.\nIf timeout is 0 this flow does not expire. "units": "string", Rate units.
"value": "integer" Remaining bandwidth value.
range: "1..4294967295"
}, "units": "string", Rate units.
"value": "integer" Remaining bandwidth value.
range: "1..4294967295"
}
}, "unit": "string", Remaining bandwidth units.
"value": "integer" Remaining bandwidth value.
},
"http-redirect": "string", Policy action http redirect.\nRedirect to this url. "default": [ null ], Use system default routing table. : { "ipv6-address": "string", IPv6 address.
"ipv4-address": "string", IPv4 address.
"vrf": "string" VRF name.
}
}, "max-flow": "integer", Max simultaneous flows monitored per policy class
range: "0..4096"
"interval-duration": "integer", Monitored interval duration.
units: "seconds"
"timeout": "integer", Declare a flow dead if no packets received in\nso much time
units: "seconds"
"history": "integer" Keep stats/metrics on box for so many intervals.
},
"class-type": "enumeration", Type of class-map.
Options:
qos
traffic
subscriber-control "policy-name": "string", Name of service-policy.
"type": "string" Type of policy-map.
}, "unit": "string", Remaining bandwidth units.
"value": "integer" Remaining bandwidth value.
},
"decap-gre": [ null ], Policy action DECAP GRE. {
"cos": "string", WRED based on CoS.
range: "0..7"
"threshold-max-value": "integer", Maximum RED threshold value.
"precedence": "string", WRED based on precedence.
range: "0..7"
"threshold-min-value": "integer", Minimum RED threshold value.
"threshold-max-units": "string", Maximum RED threshold units.
"dscp": "string", WRED based on DSCP.
"dei": "integer", DEI based WRED.\nShould be value 0..1.
range: "0..1"
"threshold-min-units": "string", Minimum RED threshold units.
"ecn": [ null ], ECN based WRED.
"discard-class": "string", WRED based on discard class.
range: "0..7"
"mpls-exp": "string" MPLS Experimental value based WRED.
range: "0..7"
}
]
}
],
"type": "enumeration", Type of policy-map.
Options:
qos
pbr
traffic
subscriber-control
accounting
redirect
flow-monitor
"description": "string", Description for this policy-map.
"name": "string" Name of policy-map.
}
]
}
}
POLICY-MAP - Update
Update operation of resource: policy-map
policy-mapbody object
ID of type name
Request Content-Types: application/json
Request Example
{ { {
"event-mode-match-all": [ null ], Execute all the matched classes.
"event-type": "enumeration", Event type.
Options:
account-logoff
account-logon
authentication-failure
authentication-no-response
authorization-failure
authorization-no-response
credit-exhausted
exception
idle-timeout
quota-depleted
service-start
service-stop
session-activate
session-start
session-stop
timer-expiry { { "aaa-list": "string", Name of the AAA method list.
"password": "string", Specify a password to be used for AAA\nrequest.
"identifier": "enumeration", Specify an Authorize format name.
Options:
circuit-id
dhcp-client-id
remote-id
source-address-ipv4
source-address-ipv6
source-address-mac
username
"format": "string" Specify an Authorize format name.
}, "aaa-list": "string", Name of the AAA method list.
"name": "string" Name of policy-map.
}, "aaa-list": "string" Name of the AAA method list.
},
"disconnect": [ null ], Disconnect session.
"monitor": [ null ], Monitor session.
"action-sequence-number": "integer", Sequence number for this action.
range: "1..65535" "timer-value": "integer", Timer value in minutes.
units: "minutes"
"timer-name": "string" Name of the timer.
}, "timer-name": "string" Name of the timer.
}, "aaa-list": "string", Name of the AAA method list.
"name": "string" Name of policy-map.
}
}
],
"class-execution-strategy": "enumeration", Class execution strategy.
Options:
do-all
do-until-failure
do-until-success
"class-name": "string", Name of class-map.
"class-type": "enumeration" Type of class-map.
Options:
qos
traffic
subscriber-control
}
],
"event-mode-match-first": [ null ] Execute only the first matched class.
}
], { "unit": "string", Remaining bandwidth units.
"value": "integer" Remaining bandwidth value.
}, "unit": "string", Remaining bandwidth units.
"value": "integer" Remaining bandwidth value.
},
"pfc-pause-set": [ null ], Pfc Pause set value. "unit": "string", Remaining bandwidth units.
"value": "integer" Remaining bandwidth value.
}
}, "index": "integer", ASN2:index 2/4 byte (hex or decimal format)
range: "1..255"
"path-id": "integer", Service function path id.
range: "1..16777215"
"metadata": "string" Service function path metadata name.
},
"default-red": [ null ], Default random early detection
"pbr-transmit": [ null ], Policy action PBR transmit.
"fragment": "string", Policy action fragment. Fragment name "dei": "integer", DEI based WRED.\nShould be value 0..1.
range: "0..1"
"cos": "integer", WRED based on CoS.
range: "0..7"
"inner-cos": "integer", Set inner cos.
range: "0..7"
"forward-class": "integer", Sets the forward class.
range: "0..7"
"precedence": "string", WRED based on precedence.
range: "0..7"
"srp-priority": "integer", Sets the spatial reuse protocol priority value of an\noutgoing packet.
range: "0..7"
"df": "integer", Set DF bit.
range: "0..1"
"fr-de": "integer", Set FrameRelay DE bit.
range: "0..1"
"dscp-tunnel": "string", Marks a packet by setting DSCP in the tunnel header.\nThis is specific to ipsec tunnels
"mpls-experimental-top-most": "integer", Sets the experimental value of the MPLS packet top-most\nlabels.
range: "0..7"
"dscp": "string", WRED based on DSCP.
"mpls-experimental-imposition": "integer", Sets the experimental value of the MPLS packet\nimposition labels.\nImposition can be used only in service policies that\nare attached in the ingress policy
range: "0..7"
"qos-group": "integer", Sets the QoS group identifiers on IPv4 or MPLS packets.\nThe set qos-group is supported only on an ingress policy.
range: "0..512"
"traffic-class": "integer", Sets the Traffic class identifiers on IPv4 or MPLS packets.
range: "0..63"
"destination-address": "string", Destination IPv4 address.
"precedence-tunnel": "string", Sets the precedence tunnel value for ipsec.
range: "0..7"
"source-address": "string", Source IPv4 address.
"discard-class": "integer", WRED based on discard class.
range: "0..7"
"dei-imposition": "integer", Set DEI imposition bit.
range: "0..1"
"atm-clp": [ null ] Set atm cell-loss-priority bit.
}, "index": "integer", ASN2:index 2/4 byte (hex or decimal format)
range: "0..4294967295" "netmask": "string", IPv4 netmask.
"address": "string" IPv4 address.
},
"as-number": "integer" 2-byte/4-byte AS number
range: "1..4294967295"
}
}, "ipv4-next-hop": "string", IPv4 address.
"vrf": "string" VRF name.
}, "ipv6-next-hop": "string", IPv6 address.
"vrf": "string" VRF name.
}
},
"class-name": "string", Name of class-map.
"ecn-red": [ null ], ECN based random early detection "criterion-packet-rate": [ null ], React criterion packet rate.
"criterion-media-stop": [ null ], React criterion media stop.
"criterion-flow-count": [ null ], React criterion flow count. "group-count": "integer", Number of flows to reach before\ntriggering alarm
units: "number of flows"
"discrete": [ null ], Discrete alarm type.
"group-percent": "integer" Percent to reach before triggering alarm
units: "percentage"
},
"severity": "string" Severity of the alarm.
}, "less-than-equal": "string", Less than equal
"range": "string", Range
"greater-than-equal": "string", Greater than equal
"less-than": "string", Less than
"greater-than": "string" Greater than
}, "average": "integer", Trigger averaged over N intervals.
"immediate": [ null ] Immediate trigger.
}
},
"criterion-delay-factor": [ null ], React criterion delay factor.
"descrition": "string", String describing the react statement. "syslog": [ null ], Syslog.
"snmp": [ null ] SNMP.
},
"criterion-mrv": [ null ] React criterion mrv.
}, "unit": "string", Remaining bandwidth units.
"value": "integer" Remaining bandwidth value.
}, "units": "string", Rate units.
"value": "integer" Remaining bandwidth value.
}
},
"pbr-drop": [ null ], Policy action PBR drop.
"priority-level": "integer", Priority level.
range: "1..7"
"service-fragment": "string", Policy action service fragment.\nService fragment name "unit": "string", Remaining bandwidth units.
"value": "integer" Remaining bandwidth value.
}, "Transmit": [ null ], Police action transmit.
"drop": [ null ], Police action drop. "dei": "integer", DEI based WRED.\nShould be value 0..1.
range: "0..1"
"cos": "integer", WRED based on CoS.
range: "0..7"
"inner-cos": "integer", Set inner cos.
range: "0..7"
"forward-class": "integer", Sets the forward class.
range: "0..7"
"precedence": "string", WRED based on precedence.
range: "0..7"
"srp-priority": "integer", Sets the spatial reuse protocol priority value of an\noutgoing packet.
range: "0..7"
"df": "integer", Set DF bit.
range: "0..1"
"fr-de": "integer", Set FrameRelay DE bit.
range: "0..1"
"dscp-tunnel": "string", Marks a packet by setting DSCP in the tunnel header.\nThis is specific to ipsec tunnels
"mpls-experimental-top-most": "integer", Sets the experimental value of the MPLS packet top-most\nlabels.
range: "0..7"
"dscp": "string", WRED based on DSCP.
"mpls-experimental-imposition": "integer", Sets the experimental value of the MPLS packet\nimposition labels.\nImposition can be used only in service policies that\nare attached in the ingress policy
range: "0..7"
"qos-group": "integer", Sets the QoS group identifiers on IPv4 or MPLS packets.\nThe set qos-group is supported only on an ingress policy.
range: "0..512"
"traffic-class": "integer", Sets the Traffic class identifiers on IPv4 or MPLS packets.
range: "0..63"
"destination-address": "string", Destination IPv4 address.
"precedence-tunnel": "string", Sets the precedence tunnel value for ipsec.
range: "0..7"
"source-address": "string", Source IPv4 address.
"discard-class": "integer", WRED based on discard class.
range: "0..7"
"dei-imposition": "integer", Set DEI imposition bit.
range: "0..1"
"atm-clp": [ null ] Set atm cell-loss-priority bit.
}
}, "units": "string", Rate units.
"value": "integer" Remaining bandwidth value.
}, "units": "string", Rate units.
"value": "integer" Remaining bandwidth value.
}, "units": "string", Rate units.
"value": "integer" Remaining bandwidth value.
}, "Transmit": [ null ], Police action transmit.
"drop": [ null ], Police action drop. "dei": "integer", DEI based WRED.\nShould be value 0..1.
range: "0..1"
"cos": "integer", WRED based on CoS.
range: "0..7"
"inner-cos": "integer", Set inner cos.
range: "0..7"
"forward-class": "integer", Sets the forward class.
range: "0..7"
"precedence": "string", WRED based on precedence.
range: "0..7"
"srp-priority": "integer", Sets the spatial reuse protocol priority value of an\noutgoing packet.
range: "0..7"
"df": "integer", Set DF bit.
range: "0..1"
"fr-de": "integer", Set FrameRelay DE bit.
range: "0..1"
"dscp-tunnel": "string", Marks a packet by setting DSCP in the tunnel header.\nThis is specific to ipsec tunnels
"mpls-experimental-top-most": "integer", Sets the experimental value of the MPLS packet top-most\nlabels.
range: "0..7"
"dscp": "string", WRED based on DSCP.
"mpls-experimental-imposition": "integer", Sets the experimental value of the MPLS packet\nimposition labels.\nImposition can be used only in service policies that\nare attached in the ingress policy
range: "0..7"
"qos-group": "integer", Sets the QoS group identifiers on IPv4 or MPLS packets.\nThe set qos-group is supported only on an ingress policy.
range: "0..512"
"traffic-class": "integer", Sets the Traffic class identifiers on IPv4 or MPLS packets.
range: "0..63"
"destination-address": "string", Destination IPv4 address.
"precedence-tunnel": "string", Sets the precedence tunnel value for ipsec.
range: "0..7"
"source-address": "string", Source IPv4 address.
"discard-class": "integer", WRED based on discard class.
range: "0..7"
"dei-imposition": "integer", Set DEI imposition bit.
range: "0..1"
"atm-clp": [ null ] Set atm cell-loss-priority bit.
}
}, "units": "string", Rate units.
"value": "integer" Remaining bandwidth value.
}, "Transmit": [ null ], Police action transmit.
"drop": [ null ], Police action drop. "dei": "integer", DEI based WRED.\nShould be value 0..1.
range: "0..1"
"cos": "integer", WRED based on CoS.
range: "0..7"
"inner-cos": "integer", Set inner cos.
range: "0..7"
"forward-class": "integer", Sets the forward class.
range: "0..7"
"precedence": "string", WRED based on precedence.
range: "0..7"
"srp-priority": "integer", Sets the spatial reuse protocol priority value of an\noutgoing packet.
range: "0..7"
"df": "integer", Set DF bit.
range: "0..1"
"fr-de": "integer", Set FrameRelay DE bit.
range: "0..1"
"dscp-tunnel": "string", Marks a packet by setting DSCP in the tunnel header.\nThis is specific to ipsec tunnels
"mpls-experimental-top-most": "integer", Sets the experimental value of the MPLS packet top-most\nlabels.
range: "0..7"
"dscp": "string", WRED based on DSCP.
"mpls-experimental-imposition": "integer", Sets the experimental value of the MPLS packet\nimposition labels.\nImposition can be used only in service policies that\nare attached in the ingress policy
range: "0..7"
"qos-group": "integer", Sets the QoS group identifiers on IPv4 or MPLS packets.\nThe set qos-group is supported only on an ingress policy.
range: "0..512"
"traffic-class": "integer", Sets the Traffic class identifiers on IPv4 or MPLS packets.
range: "0..63"
"destination-address": "string", Destination IPv4 address.
"precedence-tunnel": "string", Sets the precedence tunnel value for ipsec.
range: "0..7"
"source-address": "string", Source IPv4 address.
"discard-class": "integer", WRED based on discard class.
range: "0..7"
"dei-imposition": "integer", Set DEI imposition bit.
range: "0..1"
"atm-clp": [ null ] Set atm cell-loss-priority bit.
}
}
}, "subscriberip": [ null ], Subscriber IP
"hostname": [ null ], Hostname
"subscribermac": [ null ], Subscriber Mac
"bngidentifierinterface": [ null ] Bng Identifier Interface
}, "layer3": "integer", Nominal rate specified at the L3 (IP).
units: "bps"
"media": "integer", Nominal data rate of the media flow (ip payload).
range: "1..3000000000"
units: "bps"
"packet": "integer" Nominal IP layer packet rate (in pps).
units: "pps"
}, "count-in-layer3": "integer", Nominal number of media packets in an IP payload.
range: "1..64"
units: "packets"
"size": "integer" Nominal size of the media-packet.
units: "bytes"
}
}, "flow-idle-timeout": "string", The interval after which a flow is removed,\nif there is no activity.\nIf timeout is 0 this flow does not expire. "units": "string", Rate units.
"value": "integer" Remaining bandwidth value.
range: "1..4294967295"
}, "units": "string", Rate units.
"value": "integer" Remaining bandwidth value.
range: "1..4294967295"
}
}, "unit": "string", Remaining bandwidth units.
"value": "integer" Remaining bandwidth value.
},
"http-redirect": "string", Policy action http redirect.\nRedirect to this url. "default": [ null ], Use system default routing table. : { "ipv6-address": "string", IPv6 address.
"ipv4-address": "string", IPv4 address.
"vrf": "string" VRF name.
}
}, "max-flow": "integer", Max simultaneous flows monitored per policy class
range: "0..4096"
"interval-duration": "integer", Monitored interval duration.
units: "seconds"
"timeout": "integer", Declare a flow dead if no packets received in\nso much time
units: "seconds"
"history": "integer" Keep stats/metrics on box for so many intervals.
},
"class-type": "enumeration", Type of class-map.
Options:
qos
traffic
subscriber-control "policy-name": "string", Name of service-policy.
"type": "string" Type of policy-map.
}, "unit": "string", Remaining bandwidth units.
"value": "integer" Remaining bandwidth value.
},
"decap-gre": [ null ], Policy action DECAP GRE. {
"cos": "string", WRED based on CoS.
range: "0..7"
"threshold-max-value": "integer", Maximum RED threshold value.
"precedence": "string", WRED based on precedence.
range: "0..7"
"threshold-min-value": "integer", Minimum RED threshold value.
"threshold-max-units": "string", Maximum RED threshold units.
"dscp": "string", WRED based on DSCP.
"dei": "integer", DEI based WRED.\nShould be value 0..1.
range: "0..1"
"threshold-min-units": "string", Minimum RED threshold units.
"ecn": [ null ], ECN based WRED.
"discard-class": "string", WRED based on discard class.
range: "0..7"
"mpls-exp": "string" MPLS Experimental value based WRED.
range: "0..7"
}
]
}
],
"type": "enumeration", Type of policy-map.
Options:
qos
pbr
traffic
subscriber-control
accounting
redirect
flow-monitor
"description": "string", Description for this policy-map.
"name": "string" Name of policy-map.
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
POLICY-MAP - Create
Create operation of resource: policy-map
policy-mapbody object
ID of type name
Request Content-Types: application/json
Request Example
{ { {
"event-mode-match-all": [ null ], Execute all the matched classes.
"event-type": "enumeration", Event type.
Options:
account-logoff
account-logon
authentication-failure
authentication-no-response
authorization-failure
authorization-no-response
credit-exhausted
exception
idle-timeout
quota-depleted
service-start
service-stop
session-activate
session-start
session-stop
timer-expiry { { "aaa-list": "string", Name of the AAA method list.
"password": "string", Specify a password to be used for AAA\nrequest.
"identifier": "enumeration", Specify an Authorize format name.
Options:
circuit-id
dhcp-client-id
remote-id
source-address-ipv4
source-address-ipv6
source-address-mac
username
"format": "string" Specify an Authorize format name.
}, "aaa-list": "string", Name of the AAA method list.
"name": "string" Name of policy-map.
}, "aaa-list": "string" Name of the AAA method list.
},
"disconnect": [ null ], Disconnect session.
"monitor": [ null ], Monitor session.
"action-sequence-number": "integer", Sequence number for this action.
range: "1..65535" "timer-value": "integer", Timer value in minutes.
units: "minutes"
"timer-name": "string" Name of the timer.
}, "timer-name": "string" Name of the timer.
}, "aaa-list": "string", Name of the AAA method list.
"name": "string" Name of policy-map.
}
}
],
"class-execution-strategy": "enumeration", Class execution strategy.
Options:
do-all
do-until-failure
do-until-success
"class-name": "string", Name of class-map.
"class-type": "enumeration" Type of class-map.
Options:
qos
traffic
subscriber-control
}
],
"event-mode-match-first": [ null ] Execute only the first matched class.
}
], { "unit": "string", Remaining bandwidth units.
"value": "integer" Remaining bandwidth value.
}, "unit": "string", Remaining bandwidth units.
"value": "integer" Remaining bandwidth value.
},
"pfc-pause-set": [ null ], Pfc Pause set value. "unit": "string", Remaining bandwidth units.
"value": "integer" Remaining bandwidth value.
}
}, "index": "integer", ASN2:index 2/4 byte (hex or decimal format)
range: "1..255"
"path-id": "integer", Service function path id.
range: "1..16777215"
"metadata": "string" Service function path metadata name.
},
"default-red": [ null ], Default random early detection
"pbr-transmit": [ null ], Policy action PBR transmit.
"fragment": "string", Policy action fragment. Fragment name "dei": "integer", DEI based WRED.\nShould be value 0..1.
range: "0..1"
"cos": "integer", WRED based on CoS.
range: "0..7"
"inner-cos": "integer", Set inner cos.
range: "0..7"
"forward-class": "integer", Sets the forward class.
range: "0..7"
"precedence": "string", WRED based on precedence.
range: "0..7"
"srp-priority": "integer", Sets the spatial reuse protocol priority value of an\noutgoing packet.
range: "0..7"
"df": "integer", Set DF bit.
range: "0..1"
"fr-de": "integer", Set FrameRelay DE bit.
range: "0..1"
"dscp-tunnel": "string", Marks a packet by setting DSCP in the tunnel header.\nThis is specific to ipsec tunnels
"mpls-experimental-top-most": "integer", Sets the experimental value of the MPLS packet top-most\nlabels.
range: "0..7"
"dscp": "string", WRED based on DSCP.
"mpls-experimental-imposition": "integer", Sets the experimental value of the MPLS packet\nimposition labels.\nImposition can be used only in service policies that\nare attached in the ingress policy
range: "0..7"
"qos-group": "integer", Sets the QoS group identifiers on IPv4 or MPLS packets.\nThe set qos-group is supported only on an ingress policy.
range: "0..512"
"traffic-class": "integer", Sets the Traffic class identifiers on IPv4 or MPLS packets.
range: "0..63"
"destination-address": "string", Destination IPv4 address.
"precedence-tunnel": "string", Sets the precedence tunnel value for ipsec.
range: "0..7"
"source-address": "string", Source IPv4 address.
"discard-class": "integer", WRED based on discard class.
range: "0..7"
"dei-imposition": "integer", Set DEI imposition bit.
range: "0..1"
"atm-clp": [ null ] Set atm cell-loss-priority bit.
}, "index": "integer", ASN2:index 2/4 byte (hex or decimal format)
range: "0..4294967295" "netmask": "string", IPv4 netmask.
"address": "string" IPv4 address.
},
"as-number": "integer" 2-byte/4-byte AS number
range: "1..4294967295"
}
}, "ipv4-next-hop": "string", IPv4 address.
"vrf": "string" VRF name.
}, "ipv6-next-hop": "string", IPv6 address.
"vrf": "string" VRF name.
}
},
"class-name": "string", Name of class-map.
"ecn-red": [ null ], ECN based random early detection "criterion-packet-rate": [ null ], React criterion packet rate.
"criterion-media-stop": [ null ], React criterion media stop.
"criterion-flow-count": [ null ], React criterion flow count. "group-count": "integer", Number of flows to reach before\ntriggering alarm
units: "number of flows"
"discrete": [ null ], Discrete alarm type.
"group-percent": "integer" Percent to reach before triggering alarm
units: "percentage"
},
"severity": "string" Severity of the alarm.
}, "less-than-equal": "string", Less than equal
"range": "string", Range
"greater-than-equal": "string", Greater than equal
"less-than": "string", Less than
"greater-than": "string" Greater than
}, "average": "integer", Trigger averaged over N intervals.
"immediate": [ null ] Immediate trigger.
}
},
"criterion-delay-factor": [ null ], React criterion delay factor.
"descrition": "string", String describing the react statement. "syslog": [ null ], Syslog.
"snmp": [ null ] SNMP.
},
"criterion-mrv": [ null ] React criterion mrv.
}, "unit": "string", Remaining bandwidth units.
"value": "integer" Remaining bandwidth value.
}, "units": "string", Rate units.
"value": "integer" Remaining bandwidth value.
}
},
"pbr-drop": [ null ], Policy action PBR drop.
"priority-level": "integer", Priority level.
range: "1..7"
"service-fragment": "string", Policy action service fragment.\nService fragment name "unit": "string", Remaining bandwidth units.
"value": "integer" Remaining bandwidth value.
}, "Transmit": [ null ], Police action transmit.
"drop": [ null ], Police action drop. "dei": "integer", DEI based WRED.\nShould be value 0..1.
range: "0..1"
"cos": "integer", WRED based on CoS.
range: "0..7"
"inner-cos": "integer", Set inner cos.
range: "0..7"
"forward-class": "integer", Sets the forward class.
range: "0..7"
"precedence": "string", WRED based on precedence.
range: "0..7"
"srp-priority": "integer", Sets the spatial reuse protocol priority value of an\noutgoing packet.
range: "0..7"
"df": "integer", Set DF bit.
range: "0..1"
"fr-de": "integer", Set FrameRelay DE bit.
range: "0..1"
"dscp-tunnel": "string", Marks a packet by setting DSCP in the tunnel header.\nThis is specific to ipsec tunnels
"mpls-experimental-top-most": "integer", Sets the experimental value of the MPLS packet top-most\nlabels.
range: "0..7"
"dscp": "string", WRED based on DSCP.
"mpls-experimental-imposition": "integer", Sets the experimental value of the MPLS packet\nimposition labels.\nImposition can be used only in service policies that\nare attached in the ingress policy
range: "0..7"
"qos-group": "integer", Sets the QoS group identifiers on IPv4 or MPLS packets.\nThe set qos-group is supported only on an ingress policy.
range: "0..512"
"traffic-class": "integer", Sets the Traffic class identifiers on IPv4 or MPLS packets.
range: "0..63"
"destination-address": "string", Destination IPv4 address.
"precedence-tunnel": "string", Sets the precedence tunnel value for ipsec.
range: "0..7"
"source-address": "string", Source IPv4 address.
"discard-class": "integer", WRED based on discard class.
range: "0..7"
"dei-imposition": "integer", Set DEI imposition bit.
range: "0..1"
"atm-clp": [ null ] Set atm cell-loss-priority bit.
}
}, "units": "string", Rate units.
"value": "integer" Remaining bandwidth value.
}, "units": "string", Rate units.
"value": "integer" Remaining bandwidth value.
}, "units": "string", Rate units.
"value": "integer" Remaining bandwidth value.
}, "Transmit": [ null ], Police action transmit.
"drop": [ null ], Police action drop. "dei": "integer", DEI based WRED.\nShould be value 0..1.
range: "0..1"
"cos": "integer", WRED based on CoS.
range: "0..7"
"inner-cos": "integer", Set inner cos.
range: "0..7"
"forward-class": "integer", Sets the forward class.
range: "0..7"
"precedence": "string", WRED based on precedence.
range: "0..7"
"srp-priority": "integer", Sets the spatial reuse protocol priority value of an\noutgoing packet.
range: "0..7"
"df": "integer", Set DF bit.
range: "0..1"
"fr-de": "integer", Set FrameRelay DE bit.
range: "0..1"
"dscp-tunnel": "string", Marks a packet by setting DSCP in the tunnel header.\nThis is specific to ipsec tunnels
"mpls-experimental-top-most": "integer", Sets the experimental value of the MPLS packet top-most\nlabels.
range: "0..7"
"dscp": "string", WRED based on DSCP.
"mpls-experimental-imposition": "integer", Sets the experimental value of the MPLS packet\nimposition labels.\nImposition can be used only in service policies that\nare attached in the ingress policy
range: "0..7"
"qos-group": "integer", Sets the QoS group identifiers on IPv4 or MPLS packets.\nThe set qos-group is supported only on an ingress policy.
range: "0..512"
"traffic-class": "integer", Sets the Traffic class identifiers on IPv4 or MPLS packets.
range: "0..63"
"destination-address": "string", Destination IPv4 address.
"precedence-tunnel": "string", Sets the precedence tunnel value for ipsec.
range: "0..7"
"source-address": "string", Source IPv4 address.
"discard-class": "integer", WRED based on discard class.
range: "0..7"
"dei-imposition": "integer", Set DEI imposition bit.
range: "0..1"
"atm-clp": [ null ] Set atm cell-loss-priority bit.
}
}, "units": "string", Rate units.
"value": "integer" Remaining bandwidth value.
}, "Transmit": [ null ], Police action transmit.
"drop": [ null ], Police action drop. "dei": "integer", DEI based WRED.\nShould be value 0..1.
range: "0..1"
"cos": "integer", WRED based on CoS.
range: "0..7"
"inner-cos": "integer", Set inner cos.
range: "0..7"
"forward-class": "integer", Sets the forward class.
range: "0..7"
"precedence": "string", WRED based on precedence.
range: "0..7"
"srp-priority": "integer", Sets the spatial reuse protocol priority value of an\noutgoing packet.
range: "0..7"
"df": "integer", Set DF bit.
range: "0..1"
"fr-de": "integer", Set FrameRelay DE bit.
range: "0..1"
"dscp-tunnel": "string", Marks a packet by setting DSCP in the tunnel header.\nThis is specific to ipsec tunnels
"mpls-experimental-top-most": "integer", Sets the experimental value of the MPLS packet top-most\nlabels.
range: "0..7"
"dscp": "string", WRED based on DSCP.
"mpls-experimental-imposition": "integer", Sets the experimental value of the MPLS packet\nimposition labels.\nImposition can be used only in service policies that\nare attached in the ingress policy
range: "0..7"
"qos-group": "integer", Sets the QoS group identifiers on IPv4 or MPLS packets.\nThe set qos-group is supported only on an ingress policy.
range: "0..512"
"traffic-class": "integer", Sets the Traffic class identifiers on IPv4 or MPLS packets.
range: "0..63"
"destination-address": "string", Destination IPv4 address.
"precedence-tunnel": "string", Sets the precedence tunnel value for ipsec.
range: "0..7"
"source-address": "string", Source IPv4 address.
"discard-class": "integer", WRED based on discard class.
range: "0..7"
"dei-imposition": "integer", Set DEI imposition bit.
range: "0..1"
"atm-clp": [ null ] Set atm cell-loss-priority bit.
}
}
}, "subscriberip": [ null ], Subscriber IP
"hostname": [ null ], Hostname
"subscribermac": [ null ], Subscriber Mac
"bngidentifierinterface": [ null ] Bng Identifier Interface
}, "layer3": "integer", Nominal rate specified at the L3 (IP).
units: "bps"
"media": "integer", Nominal data rate of the media flow (ip payload).
range: "1..3000000000"
units: "bps"
"packet": "integer" Nominal IP layer packet rate (in pps).
units: "pps"
}, "count-in-layer3": "integer", Nominal number of media packets in an IP payload.
range: "1..64"
units: "packets"
"size": "integer" Nominal size of the media-packet.
units: "bytes"
}
}, "flow-idle-timeout": "string", The interval after which a flow is removed,\nif there is no activity.\nIf timeout is 0 this flow does not expire. "units": "string", Rate units.
"value": "integer" Remaining bandwidth value.
range: "1..4294967295"
}, "units": "string", Rate units.
"value": "integer" Remaining bandwidth value.
range: "1..4294967295"
}
}, "unit": "string", Remaining bandwidth units.
"value": "integer" Remaining bandwidth value.
},
"http-redirect": "string", Policy action http redirect.\nRedirect to this url. "default": [ null ], Use system default routing table. : { "ipv6-address": "string", IPv6 address.
"ipv4-address": "string", IPv4 address.
"vrf": "string" VRF name.
}
}, "max-flow": "integer", Max simultaneous flows monitored per policy class
range: "0..4096"
"interval-duration": "integer", Monitored interval duration.
units: "seconds"
"timeout": "integer", Declare a flow dead if no packets received in\nso much time
units: "seconds"
"history": "integer" Keep stats/metrics on box for so many intervals.
},
"class-type": "enumeration", Type of class-map.
Options:
qos
traffic
subscriber-control "policy-name": "string", Name of service-policy.
"type": "string" Type of policy-map.
}, "unit": "string", Remaining bandwidth units.
"value": "integer" Remaining bandwidth value.
},
"decap-gre": [ null ], Policy action DECAP GRE. {
"cos": "string", WRED based on CoS.
range: "0..7"
"threshold-max-value": "integer", Maximum RED threshold value.
"precedence": "string", WRED based on precedence.
range: "0..7"
"threshold-min-value": "integer", Minimum RED threshold value.
"threshold-max-units": "string", Maximum RED threshold units.
"dscp": "string", WRED based on DSCP.
"dei": "integer", DEI based WRED.\nShould be value 0..1.
range: "0..1"
"threshold-min-units": "string", Minimum RED threshold units.
"ecn": [ null ], ECN based WRED.
"discard-class": "string", WRED based on discard class.
range: "0..7"
"mpls-exp": "string" MPLS Experimental value based WRED.
range: "0..7"
}
]
}
],
"type": "enumeration", Type of policy-map.
Options:
qos
pbr
traffic
subscriber-control
accounting
redirect
flow-monitor
"description": "string", Description for this policy-map.
"name": "string" Name of policy-map.
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
POLICY-MAP - Delete
Delete operation of resource: policy-map
ID of type name
Successful operation
Internal Error
Response Content-Types: application/json
POLICY-MAP - Retrieve
Retrieve operation of resource: policy-map
ID of type name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { {
"event-mode-match-all": [ null ], Execute all the matched classes.
"event-type": "enumeration", Event type.
Options:
account-logoff
account-logon
authentication-failure
authentication-no-response
authorization-failure
authorization-no-response
credit-exhausted
exception
idle-timeout
quota-depleted
service-start
service-stop
session-activate
session-start
session-stop
timer-expiry { { "aaa-list": "string", Name of the AAA method list.
"password": "string", Specify a password to be used for AAA\nrequest.
"identifier": "enumeration", Specify an Authorize format name.
Options:
circuit-id
dhcp-client-id
remote-id
source-address-ipv4
source-address-ipv6
source-address-mac
username
"format": "string" Specify an Authorize format name.
}, "aaa-list": "string", Name of the AAA method list.
"name": "string" Name of policy-map.
}, "aaa-list": "string" Name of the AAA method list.
},
"disconnect": [ null ], Disconnect session.
"monitor": [ null ], Monitor session.
"action-sequence-number": "integer", Sequence number for this action.
range: "1..65535" "timer-value": "integer", Timer value in minutes.
units: "minutes"
"timer-name": "string" Name of the timer.
}, "timer-name": "string" Name of the timer.
}, "aaa-list": "string", Name of the AAA method list.
"name": "string" Name of policy-map.
}
}
],
"class-execution-strategy": "enumeration", Class execution strategy.
Options:
do-all
do-until-failure
do-until-success
"class-name": "string", Name of class-map.
"class-type": "enumeration" Type of class-map.
Options:
qos
traffic
subscriber-control
}
],
"event-mode-match-first": [ null ] Execute only the first matched class.
}
], { "unit": "string", Remaining bandwidth units.
"value": "integer" Remaining bandwidth value.
}, "unit": "string", Remaining bandwidth units.
"value": "integer" Remaining bandwidth value.
},
"pfc-pause-set": [ null ], Pfc Pause set value. "unit": "string", Remaining bandwidth units.
"value": "integer" Remaining bandwidth value.
}
}, "index": "integer", ASN2:index 2/4 byte (hex or decimal format)
range: "1..255"
"path-id": "integer", Service function path id.
range: "1..16777215"
"metadata": "string" Service function path metadata name.
},
"default-red": [ null ], Default random early detection
"pbr-transmit": [ null ], Policy action PBR transmit.
"fragment": "string", Policy action fragment. Fragment name "dei": "integer", DEI based WRED.\nShould be value 0..1.
range: "0..1"
"cos": "integer", WRED based on CoS.
range: "0..7"
"inner-cos": "integer", Set inner cos.
range: "0..7"
"forward-class": "integer", Sets the forward class.
range: "0..7"
"precedence": "string", WRED based on precedence.
range: "0..7"
"srp-priority": "integer", Sets the spatial reuse protocol priority value of an\noutgoing packet.
range: "0..7"
"df": "integer", Set DF bit.
range: "0..1"
"fr-de": "integer", Set FrameRelay DE bit.
range: "0..1"
"dscp-tunnel": "string", Marks a packet by setting DSCP in the tunnel header.\nThis is specific to ipsec tunnels
"mpls-experimental-top-most": "integer", Sets the experimental value of the MPLS packet top-most\nlabels.
range: "0..7"
"dscp": "string", WRED based on DSCP.
"mpls-experimental-imposition": "integer", Sets the experimental value of the MPLS packet\nimposition labels.\nImposition can be used only in service policies that\nare attached in the ingress policy
range: "0..7"
"qos-group": "integer", Sets the QoS group identifiers on IPv4 or MPLS packets.\nThe set qos-group is supported only on an ingress policy.
range: "0..512"
"traffic-class": "integer", Sets the Traffic class identifiers on IPv4 or MPLS packets.
range: "0..63"
"destination-address": "string", Destination IPv4 address.
"precedence-tunnel": "string", Sets the precedence tunnel value for ipsec.
range: "0..7"
"source-address": "string", Source IPv4 address.
"discard-class": "integer", WRED based on discard class.
range: "0..7"
"dei-imposition": "integer", Set DEI imposition bit.
range: "0..1"
"atm-clp": [ null ] Set atm cell-loss-priority bit.
}, "index": "integer", ASN2:index 2/4 byte (hex or decimal format)
range: "0..4294967295" "netmask": "string", IPv4 netmask.
"address": "string" IPv4 address.
},
"as-number": "integer" 2-byte/4-byte AS number
range: "1..4294967295"
}
}, "ipv4-next-hop": "string", IPv4 address.
"vrf": "string" VRF name.
}, "ipv6-next-hop": "string", IPv6 address.
"vrf": "string" VRF name.
}
},
"class-name": "string", Name of class-map.
"ecn-red": [ null ], ECN based random early detection "criterion-packet-rate": [ null ], React criterion packet rate.
"criterion-media-stop": [ null ], React criterion media stop.
"criterion-flow-count": [ null ], React criterion flow count. "group-count": "integer", Number of flows to reach before\ntriggering alarm
units: "number of flows"
"discrete": [ null ], Discrete alarm type.
"group-percent": "integer" Percent to reach before triggering alarm
units: "percentage"
},
"severity": "string" Severity of the alarm.
}, "less-than-equal": "string", Less than equal
"range": "string", Range
"greater-than-equal": "string", Greater than equal
"less-than": "string", Less than
"greater-than": "string" Greater than
}, "average": "integer", Trigger averaged over N intervals.
"immediate": [ null ] Immediate trigger.
}
},
"criterion-delay-factor": [ null ], React criterion delay factor.
"descrition": "string", String describing the react statement. "syslog": [ null ], Syslog.
"snmp": [ null ] SNMP.
},
"criterion-mrv": [ null ] React criterion mrv.
}, "unit": "string", Remaining bandwidth units.
"value": "integer" Remaining bandwidth value.
}, "units": "string", Rate units.
"value": "integer" Remaining bandwidth value.
}
},
"pbr-drop": [ null ], Policy action PBR drop.
"priority-level": "integer", Priority level.
range: "1..7"
"service-fragment": "string", Policy action service fragment.\nService fragment name "unit": "string", Remaining bandwidth units.
"value": "integer" Remaining bandwidth value.
}, "Transmit": [ null ], Police action transmit.
"drop": [ null ], Police action drop. "dei": "integer", DEI based WRED.\nShould be value 0..1.
range: "0..1"
"cos": "integer", WRED based on CoS.
range: "0..7"
"inner-cos": "integer", Set inner cos.
range: "0..7"
"forward-class": "integer", Sets the forward class.
range: "0..7"
"precedence": "string", WRED based on precedence.
range: "0..7"
"srp-priority": "integer", Sets the spatial reuse protocol priority value of an\noutgoing packet.
range: "0..7"
"df": "integer", Set DF bit.
range: "0..1"
"fr-de": "integer", Set FrameRelay DE bit.
range: "0..1"
"dscp-tunnel": "string", Marks a packet by setting DSCP in the tunnel header.\nThis is specific to ipsec tunnels
"mpls-experimental-top-most": "integer", Sets the experimental value of the MPLS packet top-most\nlabels.
range: "0..7"
"dscp": "string", WRED based on DSCP.
"mpls-experimental-imposition": "integer", Sets the experimental value of the MPLS packet\nimposition labels.\nImposition can be used only in service policies that\nare attached in the ingress policy
range: "0..7"
"qos-group": "integer", Sets the QoS group identifiers on IPv4 or MPLS packets.\nThe set qos-group is supported only on an ingress policy.
range: "0..512"
"traffic-class": "integer", Sets the Traffic class identifiers on IPv4 or MPLS packets.
range: "0..63"
"destination-address": "string", Destination IPv4 address.
"precedence-tunnel": "string", Sets the precedence tunnel value for ipsec.
range: "0..7"
"source-address": "string", Source IPv4 address.
"discard-class": "integer", WRED based on discard class.
range: "0..7"
"dei-imposition": "integer", Set DEI imposition bit.
range: "0..1"
"atm-clp": [ null ] Set atm cell-loss-priority bit.
}
}, "units": "string", Rate units.
"value": "integer" Remaining bandwidth value.
}, "units": "string", Rate units.
"value": "integer" Remaining bandwidth value.
}, "units": "string", Rate units.
"value": "integer" Remaining bandwidth value.
}, "Transmit": [ null ], Police action transmit.
"drop": [ null ], Police action drop. "dei": "integer", DEI based WRED.\nShould be value 0..1.
range: "0..1"
"cos": "integer", WRED based on CoS.
range: "0..7"
"inner-cos": "integer", Set inner cos.
range: "0..7"
"forward-class": "integer", Sets the forward class.
range: "0..7"
"precedence": "string", WRED based on precedence.
range: "0..7"
"srp-priority": "integer", Sets the spatial reuse protocol priority value of an\noutgoing packet.
range: "0..7"
"df": "integer", Set DF bit.
range: "0..1"
"fr-de": "integer", Set FrameRelay DE bit.
range: "0..1"
"dscp-tunnel": "string", Marks a packet by setting DSCP in the tunnel header.\nThis is specific to ipsec tunnels
"mpls-experimental-top-most": "integer", Sets the experimental value of the MPLS packet top-most\nlabels.
range: "0..7"
"dscp": "string", WRED based on DSCP.
"mpls-experimental-imposition": "integer", Sets the experimental value of the MPLS packet\nimposition labels.\nImposition can be used only in service policies that\nare attached in the ingress policy
range: "0..7"
"qos-group": "integer", Sets the QoS group identifiers on IPv4 or MPLS packets.\nThe set qos-group is supported only on an ingress policy.
range: "0..512"
"traffic-class": "integer", Sets the Traffic class identifiers on IPv4 or MPLS packets.
range: "0..63"
"destination-address": "string", Destination IPv4 address.
"precedence-tunnel": "string", Sets the precedence tunnel value for ipsec.
range: "0..7"
"source-address": "string", Source IPv4 address.
"discard-class": "integer", WRED based on discard class.
range: "0..7"
"dei-imposition": "integer", Set DEI imposition bit.
range: "0..1"
"atm-clp": [ null ] Set atm cell-loss-priority bit.
}
}, "units": "string", Rate units.
"value": "integer" Remaining bandwidth value.
}, "Transmit": [ null ], Police action transmit.
"drop": [ null ], Police action drop. "dei": "integer", DEI based WRED.\nShould be value 0..1.
range: "0..1"
"cos": "integer", WRED based on CoS.
range: "0..7"
"inner-cos": "integer", Set inner cos.
range: "0..7"
"forward-class": "integer", Sets the forward class.
range: "0..7"
"precedence": "string", WRED based on precedence.
range: "0..7"
"srp-priority": "integer", Sets the spatial reuse protocol priority value of an\noutgoing packet.
range: "0..7"
"df": "integer", Set DF bit.
range: "0..1"
"fr-de": "integer", Set FrameRelay DE bit.
range: "0..1"
"dscp-tunnel": "string", Marks a packet by setting DSCP in the tunnel header.\nThis is specific to ipsec tunnels
"mpls-experimental-top-most": "integer", Sets the experimental value of the MPLS packet top-most\nlabels.
range: "0..7"
"dscp": "string", WRED based on DSCP.
"mpls-experimental-imposition": "integer", Sets the experimental value of the MPLS packet\nimposition labels.\nImposition can be used only in service policies that\nare attached in the ingress policy
range: "0..7"
"qos-group": "integer", Sets the QoS group identifiers on IPv4 or MPLS packets.\nThe set qos-group is supported only on an ingress policy.
range: "0..512"
"traffic-class": "integer", Sets the Traffic class identifiers on IPv4 or MPLS packets.
range: "0..63"
"destination-address": "string", Destination IPv4 address.
"precedence-tunnel": "string", Sets the precedence tunnel value for ipsec.
range: "0..7"
"source-address": "string", Source IPv4 address.
"discard-class": "integer", WRED based on discard class.
range: "0..7"
"dei-imposition": "integer", Set DEI imposition bit.
range: "0..1"
"atm-clp": [ null ] Set atm cell-loss-priority bit.
}
}
}, "subscriberip": [ null ], Subscriber IP
"hostname": [ null ], Hostname
"subscribermac": [ null ], Subscriber Mac
"bngidentifierinterface": [ null ] Bng Identifier Interface
}, "layer3": "integer", Nominal rate specified at the L3 (IP).
units: "bps"
"media": "integer", Nominal data rate of the media flow (ip payload).
range: "1..3000000000"
units: "bps"
"packet": "integer" Nominal IP layer packet rate (in pps).
units: "pps"
}, "count-in-layer3": "integer", Nominal number of media packets in an IP payload.
range: "1..64"
units: "packets"
"size": "integer" Nominal size of the media-packet.
units: "bytes"
}
}, "flow-idle-timeout": "string", The interval after which a flow is removed,\nif there is no activity.\nIf timeout is 0 this flow does not expire. "units": "string", Rate units.
"value": "integer" Remaining bandwidth value.
range: "1..4294967295"
}, "units": "string", Rate units.
"value": "integer" Remaining bandwidth value.
range: "1..4294967295"
}
}, "unit": "string", Remaining bandwidth units.
"value": "integer" Remaining bandwidth value.
},
"http-redirect": "string", Policy action http redirect.\nRedirect to this url. "default": [ null ], Use system default routing table. : { "ipv6-address": "string", IPv6 address.
"ipv4-address": "string", IPv4 address.
"vrf": "string" VRF name.
}
}, "max-flow": "integer", Max simultaneous flows monitored per policy class
range: "0..4096"
"interval-duration": "integer", Monitored interval duration.
units: "seconds"
"timeout": "integer", Declare a flow dead if no packets received in\nso much time
units: "seconds"
"history": "integer" Keep stats/metrics on box for so many intervals.
},
"class-type": "enumeration", Type of class-map.
Options:
qos
traffic
subscriber-control "policy-name": "string", Name of service-policy.
"type": "string" Type of policy-map.
}, "unit": "string", Remaining bandwidth units.
"value": "integer" Remaining bandwidth value.
},
"decap-gre": [ null ], Policy action DECAP GRE. {
"cos": "string", WRED based on CoS.
range: "0..7"
"threshold-max-value": "integer", Maximum RED threshold value.
"precedence": "string", WRED based on precedence.
range: "0..7"
"threshold-min-value": "integer", Minimum RED threshold value.
"threshold-max-units": "string", Maximum RED threshold units.
"dscp": "string", WRED based on DSCP.
"dei": "integer", DEI based WRED.\nShould be value 0..1.
range: "0..1"
"threshold-min-units": "string", Minimum RED threshold units.
"ecn": [ null ], ECN based WRED.
"discard-class": "string", WRED based on discard class.
range: "0..7"
"mpls-exp": "string" MPLS Experimental value based WRED.
range: "0..7"
}
]
}
],
"type": "enumeration", Type of policy-map.
Options:
qos
pbr
traffic
subscriber-control
accounting
redirect
flow-monitor
"description": "string", Description for this policy-map.
"name": "string" Name of policy-map.
}
]
}
EVENT - Update
Update operation of resource: event
eventbody object
ID of type name
ID of event-type
Request Content-Types: application/json
Request Example
{ "event-mode-match-all": [ null ], Execute all the matched classes.
"event-type": "enumeration", Event type.
Options:
account-logoff
account-logon
authentication-failure
authentication-no-response
authorization-failure
authorization-no-response
credit-exhausted
exception
idle-timeout
quota-depleted
service-start
service-stop
session-activate
session-start
session-stop
timer-expiry { { "aaa-list": "string", Name of the AAA method list.
"password": "string", Specify a password to be used for AAA\nrequest.
"identifier": "enumeration", Specify an Authorize format name.
Options:
circuit-id
dhcp-client-id
remote-id
source-address-ipv4
source-address-ipv6
source-address-mac
username
"format": "string" Specify an Authorize format name.
}, "aaa-list": "string", Name of the AAA method list.
"name": "string" Dynamic template name.
}, "aaa-list": "string" Name of the AAA method list.
},
"disconnect": [ null ], Disconnect session.
"monitor": [ null ], Monitor session.
"action-sequence-number": "integer", Sequence number for this action.
range: "1..65535" "timer-value": "integer", Timer value in minutes.
units: "minutes"
"timer-name": "string" Name of the timer.
}, "timer-name": "string" Name of the timer.
}, "aaa-list": "string", Name of the AAA method list.
"name": "string" Dynamic template name.
}
}
],
"class-execution-strategy": "enumeration", Class execution strategy.
Options:
do-all
do-until-failure
do-until-success
"class-name": "string", Name of class.
"class-type": "enumeration" Type of class.
Options:
qos
traffic
subscriber-control
}
],
"event-mode-match-first": [ null ] Execute only the first matched class.
}
}
Successful operation
Internal Error
Response Content-Types: application/json
EVENT - Create
Create operation of resource: event
eventbody object
ID of type name
ID of event-type
Request Content-Types: application/json
Request Example
{ "event-mode-match-all": [ null ], Execute all the matched classes.
"event-type": "enumeration", Event type.
Options:
account-logoff
account-logon
authentication-failure
authentication-no-response
authorization-failure
authorization-no-response
credit-exhausted
exception
idle-timeout
quota-depleted
service-start
service-stop
session-activate
session-start
session-stop
timer-expiry { { "aaa-list": "string", Name of the AAA method list.
"password": "string", Specify a password to be used for AAA\nrequest.
"identifier": "enumeration", Specify an Authorize format name.
Options:
circuit-id
dhcp-client-id
remote-id
source-address-ipv4
source-address-ipv6
source-address-mac
username
"format": "string" Specify an Authorize format name.
}, "aaa-list": "string", Name of the AAA method list.
"name": "string" Dynamic template name.
}, "aaa-list": "string" Name of the AAA method list.
},
"disconnect": [ null ], Disconnect session.
"monitor": [ null ], Monitor session.
"action-sequence-number": "integer", Sequence number for this action.
range: "1..65535" "timer-value": "integer", Timer value in minutes.
units: "minutes"
"timer-name": "string" Name of the timer.
}, "timer-name": "string" Name of the timer.
}, "aaa-list": "string", Name of the AAA method list.
"name": "string" Dynamic template name.
}
}
],
"class-execution-strategy": "enumeration", Class execution strategy.
Options:
do-all
do-until-failure
do-until-success
"class-name": "string", Name of class.
"class-type": "enumeration" Type of class.
Options:
qos
traffic
subscriber-control
}
],
"event-mode-match-first": [ null ] Execute only the first matched class.
}
}
Successful operation
Internal Error
Response Content-Types: application/json
EVENT - Delete
Delete operation of resource: event
ID of type name
ID of event-type
Successful operation
Internal Error
Response Content-Types: application/json
EVENT - Retrieve
Retrieve operation of resource: event
ID of type name
ID of event-type
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "event-mode-match-all": [ null ], Execute all the matched classes.
"event-type": "enumeration", Event type.
Options:
account-logoff
account-logon
authentication-failure
authentication-no-response
authorization-failure
authorization-no-response
credit-exhausted
exception
idle-timeout
quota-depleted
service-start
service-stop
session-activate
session-start
session-stop
timer-expiry { { "aaa-list": "string", Name of the AAA method list.
"password": "string", Specify a password to be used for AAA\nrequest.
"identifier": "enumeration", Specify an Authorize format name.
Options:
circuit-id
dhcp-client-id
remote-id
source-address-ipv4
source-address-ipv6
source-address-mac
username
"format": "string" Specify an Authorize format name.
}, "aaa-list": "string", Name of the AAA method list.
"name": "string" Dynamic template name.
}, "aaa-list": "string" Name of the AAA method list.
},
"disconnect": [ null ], Disconnect session.
"monitor": [ null ], Monitor session.
"action-sequence-number": "integer", Sequence number for this action.
range: "1..65535" "timer-value": "integer", Timer value in minutes.
units: "minutes"
"timer-name": "string" Name of the timer.
}, "timer-name": "string" Name of the timer.
}, "aaa-list": "string", Name of the AAA method list.
"name": "string" Dynamic template name.
}
}
],
"class-execution-strategy": "enumeration", Class execution strategy.
Options:
do-all
do-until-failure
do-until-success
"class-name": "string", Name of class.
"class-type": "enumeration" Type of class.
Options:
qos
traffic
subscriber-control
}
],
"event-mode-match-first": [ null ] Execute only the first matched class.
}
}
CLASS - Update
Update operation of resource: class
classbody object
ID of type name
ID of event-type
ID of class-name class-type
Request Content-Types: application/json
Request Example
{ { "aaa-list": "string", Name of the AAA method list.
"password": "string", Specify a password to be used for AAA\nrequest.
"identifier": "enumeration", Specify an Authorize format name.
Options:
circuit-id
dhcp-client-id
remote-id
source-address-ipv4
source-address-ipv6
source-address-mac
username
"format": "string" Specify an Authorize format name.
}, "aaa-list": "string", Name of the AAA method list.
"name": "string" Dynamic template name.
}, "aaa-list": "string" Name of the AAA method list.
},
"disconnect": [ null ], Disconnect session.
"monitor": [ null ], Monitor session.
"action-sequence-number": "integer", Sequence number for this action.
range: "1..65535" "timer-value": "integer", Timer value in minutes.
units: "minutes"
"timer-name": "string" Name of the timer.
}, "timer-name": "string" Name of the timer.
}, "aaa-list": "string", Name of the AAA method list.
"name": "string" Dynamic template name.
}
}
],
"class-execution-strategy": "enumeration", Class execution strategy.
Options:
do-all
do-until-failure
do-until-success
"class-name": "string", Name of class.
"class-type": "enumeration" Type of class.
Options:
qos
traffic
subscriber-control
}
}
Successful operation
Internal Error
Response Content-Types: application/json
CLASS - Create
Create operation of resource: class
classbody object
ID of type name
ID of event-type
ID of class-name class-type
Request Content-Types: application/json
Request Example
{ { "aaa-list": "string", Name of the AAA method list.
"password": "string", Specify a password to be used for AAA\nrequest.
"identifier": "enumeration", Specify an Authorize format name.
Options:
circuit-id
dhcp-client-id
remote-id
source-address-ipv4
source-address-ipv6
source-address-mac
username
"format": "string" Specify an Authorize format name.
}, "aaa-list": "string", Name of the AAA method list.
"name": "string" Dynamic template name.
}, "aaa-list": "string" Name of the AAA method list.
},
"disconnect": [ null ], Disconnect session.
"monitor": [ null ], Monitor session.
"action-sequence-number": "integer", Sequence number for this action.
range: "1..65535" "timer-value": "integer", Timer value in minutes.
units: "minutes"
"timer-name": "string" Name of the timer.
}, "timer-name": "string" Name of the timer.
}, "aaa-list": "string", Name of the AAA method list.
"name": "string" Dynamic template name.
}
}
],
"class-execution-strategy": "enumeration", Class execution strategy.
Options:
do-all
do-until-failure
do-until-success
"class-name": "string", Name of class.
"class-type": "enumeration" Type of class.
Options:
qos
traffic
subscriber-control
}
}
Successful operation
Internal Error
Response Content-Types: application/json
CLASS - Delete
Delete operation of resource: class
ID of type name
ID of event-type
ID of class-name class-type
Successful operation
Internal Error
Response Content-Types: application/json
CLASS - Retrieve
Retrieve operation of resource: class
ID of type name
ID of event-type
ID of class-name class-type
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { "aaa-list": "string", Name of the AAA method list.
"password": "string", Specify a password to be used for AAA\nrequest.
"identifier": "enumeration", Specify an Authorize format name.
Options:
circuit-id
dhcp-client-id
remote-id
source-address-ipv4
source-address-ipv6
source-address-mac
username
"format": "string" Specify an Authorize format name.
}, "aaa-list": "string", Name of the AAA method list.
"name": "string" Dynamic template name.
}, "aaa-list": "string" Name of the AAA method list.
},
"disconnect": [ null ], Disconnect session.
"monitor": [ null ], Monitor session.
"action-sequence-number": "integer", Sequence number for this action.
range: "1..65535" "timer-value": "integer", Timer value in minutes.
units: "minutes"
"timer-name": "string" Name of the timer.
}, "timer-name": "string" Name of the timer.
}, "aaa-list": "string", Name of the AAA method list.
"name": "string" Dynamic template name.
}
}
],
"class-execution-strategy": "enumeration", Class execution strategy.
Options:
do-all
do-until-failure
do-until-success
"class-name": "string", Name of class.
"class-type": "enumeration" Type of class.
Options:
qos
traffic
subscriber-control
}
}
ACTION-RULE - Update
Update operation of resource: action-rule
action-rulebody object
ID of type name
ID of event-type
ID of class-name class-type
ID of action-sequence-number
Request Content-Types: application/json
Request Example
{ "aaa-list": "string", Name of the AAA method list.
"password": "string", Specify a password to be used for AAA\nrequest.
"identifier": "enumeration", Specify an Authorize format name.
Options:
circuit-id
dhcp-client-id
remote-id
source-address-ipv4
source-address-ipv6
source-address-mac
username
"format": "string" Specify an Authorize format name.
}, "aaa-list": "string", Name of the AAA method list.
"name": "string" Dynamic template name.
}, "aaa-list": "string" Name of the AAA method list.
},
"disconnect": [ null ], Disconnect session.
"monitor": [ null ], Monitor session.
"action-sequence-number": "integer", Sequence number for this action.
range: "1..65535" "timer-value": "integer", Timer value in minutes.
units: "minutes"
"timer-name": "string" Name of the timer.
}, "timer-name": "string" Name of the timer.
}, "aaa-list": "string", Name of the AAA method list.
"name": "string" Dynamic template name.
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ACTION-RULE - Create
Create operation of resource: action-rule
action-rulebody object
ID of type name
ID of event-type
ID of class-name class-type
ID of action-sequence-number
Request Content-Types: application/json
Request Example
{ "aaa-list": "string", Name of the AAA method list.
"password": "string", Specify a password to be used for AAA\nrequest.
"identifier": "enumeration", Specify an Authorize format name.
Options:
circuit-id
dhcp-client-id
remote-id
source-address-ipv4
source-address-ipv6
source-address-mac
username
"format": "string" Specify an Authorize format name.
}, "aaa-list": "string", Name of the AAA method list.
"name": "string" Dynamic template name.
}, "aaa-list": "string" Name of the AAA method list.
},
"disconnect": [ null ], Disconnect session.
"monitor": [ null ], Monitor session.
"action-sequence-number": "integer", Sequence number for this action.
range: "1..65535" "timer-value": "integer", Timer value in minutes.
units: "minutes"
"timer-name": "string" Name of the timer.
}, "timer-name": "string" Name of the timer.
}, "aaa-list": "string", Name of the AAA method list.
"name": "string" Dynamic template name.
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ACTION-RULE - Delete
Delete operation of resource: action-rule
ID of type name
ID of event-type
ID of class-name class-type
ID of action-sequence-number
Successful operation
Internal Error
Response Content-Types: application/json
ACTION-RULE - Retrieve
Retrieve operation of resource: action-rule
ID of type name
ID of event-type
ID of class-name class-type
ID of action-sequence-number
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "aaa-list": "string", Name of the AAA method list.
"password": "string", Specify a password to be used for AAA\nrequest.
"identifier": "enumeration", Specify an Authorize format name.
Options:
circuit-id
dhcp-client-id
remote-id
source-address-ipv4
source-address-ipv6
source-address-mac
username
"format": "string" Specify an Authorize format name.
}, "aaa-list": "string", Name of the AAA method list.
"name": "string" Dynamic template name.
}, "aaa-list": "string" Name of the AAA method list.
},
"disconnect": [ null ], Disconnect session.
"monitor": [ null ], Monitor session.
"action-sequence-number": "integer", Sequence number for this action.
range: "1..65535" "timer-value": "integer", Timer value in minutes.
units: "minutes"
"timer-name": "string" Name of the timer.
}, "timer-name": "string" Name of the timer.
}, "aaa-list": "string", Name of the AAA method list.
"name": "string" Dynamic template name.
}
}
}
ACTIVATE-DYNAMIC-TEMPLATE - Update
Update operation of resource: activate-dynamic-template
activate-dynamic-templatebody object
ID of type name
ID of event-type
ID of class-name class-type
ID of action-sequence-number
Successful operation
Internal Error
Response Content-Types: application/json
ACTIVATE-DYNAMIC-TEMPLATE - Create
Create operation of resource: activate-dynamic-template
activate-dynamic-templatebody object
ID of type name
ID of event-type
ID of class-name class-type
ID of action-sequence-number
Successful operation
Internal Error
Response Content-Types: application/json
ACTIVATE-DYNAMIC-TEMPLATE - Delete
Delete operation of resource: activate-dynamic-template
ID of type name
ID of event-type
ID of class-name class-type
ID of action-sequence-number
Successful operation
Internal Error
Response Content-Types: application/json
ACTIVATE-DYNAMIC-TEMPLATE - Retrieve
Retrieve operation of resource: activate-dynamic-template
ID of type name
ID of event-type
ID of class-name class-type
ID of action-sequence-number
Successful operation
Internal Error
AUTHENTICATE - Update
Update operation of resource: authenticate
authenticatebody object
ID of type name
ID of event-type
ID of class-name class-type
ID of action-sequence-number
Successful operation
Internal Error
Response Content-Types: application/json
AUTHENTICATE - Create
Create operation of resource: authenticate
authenticatebody object
ID of type name
ID of event-type
ID of class-name class-type
ID of action-sequence-number
Successful operation
Internal Error
Response Content-Types: application/json
AUTHENTICATE - Delete
Delete operation of resource: authenticate
ID of type name
ID of event-type
ID of class-name class-type
ID of action-sequence-number
Successful operation
Internal Error
Response Content-Types: application/json
AUTHENTICATE - Retrieve
Retrieve operation of resource: authenticate
ID of type name
ID of event-type
ID of class-name class-type
ID of action-sequence-number
Successful operation
Internal Error
DEACTIVATE-DYNAMIC-TEMPLATE - Update
Update operation of resource: deactivate-dynamic-template
deactivate-dynamic-templatebody object
ID of type name
ID of event-type
ID of class-name class-type
ID of action-sequence-number
Successful operation
Internal Error
Response Content-Types: application/json
DEACTIVATE-DYNAMIC-TEMPLATE - Create
Create operation of resource: deactivate-dynamic-template
deactivate-dynamic-templatebody object
ID of type name
ID of event-type
ID of class-name class-type
ID of action-sequence-number
Successful operation
Internal Error
Response Content-Types: application/json
DEACTIVATE-DYNAMIC-TEMPLATE - Delete
Delete operation of resource: deactivate-dynamic-template
ID of type name
ID of event-type
ID of class-name class-type
ID of action-sequence-number
Successful operation
Internal Error
Response Content-Types: application/json
DEACTIVATE-DYNAMIC-TEMPLATE - Retrieve
Retrieve operation of resource: deactivate-dynamic-template
ID of type name
ID of event-type
ID of class-name class-type
ID of action-sequence-number
Successful operation
Internal Error
SET-TIMER - Update
Update operation of resource: set-timer
set-timerbody object
ID of type name
ID of event-type
ID of class-name class-type
ID of action-sequence-number
Successful operation
Internal Error
Response Content-Types: application/json
SET-TIMER - Create
Create operation of resource: set-timer
set-timerbody object
ID of type name
ID of event-type
ID of class-name class-type
ID of action-sequence-number
Successful operation
Internal Error
Response Content-Types: application/json
SET-TIMER - Delete
Delete operation of resource: set-timer
ID of type name
ID of event-type
ID of class-name class-type
ID of action-sequence-number
Successful operation
Internal Error
Response Content-Types: application/json
SET-TIMER - Retrieve
Retrieve operation of resource: set-timer
ID of type name
ID of event-type
ID of class-name class-type
ID of action-sequence-number
Successful operation
Internal Error
STOP-TIMER - Update
Update operation of resource: stop-timer
stop-timerbody object
ID of type name
ID of event-type
ID of class-name class-type
ID of action-sequence-number
Successful operation
Internal Error
Response Content-Types: application/json
STOP-TIMER - Create
Create operation of resource: stop-timer
stop-timerbody object
ID of type name
ID of event-type
ID of class-name class-type
ID of action-sequence-number
Successful operation
Internal Error
Response Content-Types: application/json
STOP-TIMER - Delete
Delete operation of resource: stop-timer
ID of type name
ID of event-type
ID of class-name class-type
ID of action-sequence-number
Successful operation
Internal Error
Response Content-Types: application/json
STOP-TIMER - Retrieve
Retrieve operation of resource: stop-timer
ID of type name
ID of event-type
ID of class-name class-type
ID of action-sequence-number
Successful operation
Internal Error
POLICY-MAP-RULE - Update
Update operation of resource: policy-map-rule
policy-map-rulebody object
ID of type name
ID of class-name class-type
Request Content-Types: application/json
Request Example
{ "unit": "string", Remaining bandwidth units.
"value": "integer" Remaining bandwidth value.
}, "unit": "string", Remaining bandwidth units.
"value": "integer" Remaining bandwidth value.
},
"pfc-pause-set": [ null ], Pfc Pause set value. "unit": "string", Remaining bandwidth units.
"value": "integer" Remaining bandwidth value.
}
}, "index": "integer", ASN2:index 2/4 byte (hex or decimal format)
range: "1..255"
"path-id": "integer", Service function path id.
range: "1..16777215"
"metadata": "string" Service function path metadata name.
},
"default-red": [ null ], Default random early detection
"pbr-transmit": [ null ], Policy action PBR transmit.
"fragment": "string", Policy action fragment. Fragment name "dei": "integer", DEI based WRED.\nShould be value 0..1.
range: "0..1"
"cos": "integer", WRED based on CoS.
range: "0..7"
"inner-cos": "integer", Set inner cos.
range: "0..7"
"forward-class": "integer", Sets the forward class.
range: "0..7"
"precedence": "string", WRED based on precedence.
range: "0..7"
"srp-priority": "integer", Sets the spatial reuse protocol priority value of an\noutgoing packet.
range: "0..7"
"df": "integer", Set DF bit.
range: "0..1"
"fr-de": "integer", Set FrameRelay DE bit.
range: "0..1"
"dscp-tunnel": "string", Marks a packet by setting DSCP in the tunnel header.\nThis is specific to ipsec tunnels
"mpls-experimental-top-most": "integer", Sets the experimental value of the MPLS packet top-most\nlabels.
range: "0..7"
"dscp": "string", WRED based on DSCP.
"mpls-experimental-imposition": "integer", Sets the experimental value of the MPLS packet\nimposition labels.\nImposition can be used only in service policies that\nare attached in the ingress policy
range: "0..7"
"qos-group": "integer", Sets the QoS group identifiers on IPv4 or MPLS packets.\nThe set qos-group is supported only on an ingress policy.
range: "0..512"
"traffic-class": "integer", Sets the Traffic class identifiers on IPv4 or MPLS packets.
range: "0..63"
"destination-address": "string", Destination IPv4 address.
"precedence-tunnel": "string", Sets the precedence tunnel value for ipsec.
range: "0..7"
"source-address": "string", Source IPv4 address.
"discard-class": "integer", WRED based on discard class.
range: "0..7"
"dei-imposition": "integer", Set DEI imposition bit.
range: "0..1"
"atm-clp": [ null ] Set atm cell-loss-priority bit.
}, "index": "integer", ASN2:index 2/4 byte (hex or decimal format)
range: "0..4294967295" "netmask": "string", IPv4 netmask.
"address": "string" IPv4 address.
},
"as-number": "integer" 2-byte/4-byte AS number
range: "1..4294967295"
}
}, "ipv4-next-hop": "string", IPv4 address.
"vrf": "string" VRF name.
}, "ipv6-next-hop": "string", IPv6 address.
"vrf": "string" VRF name.
}
},
"class-name": "string", Name of class-map.
"ecn-red": [ null ], ECN based random early detection "criterion-packet-rate": [ null ], React criterion packet rate.
"criterion-media-stop": [ null ], React criterion media stop.
"criterion-flow-count": [ null ], React criterion flow count. "group-count": "integer", Number of flows to reach before\ntriggering alarm
units: "number of flows"
"discrete": [ null ], Discrete alarm type.
"group-percent": "integer" Percent to reach before triggering alarm
units: "percentage"
},
"severity": "string" Severity of the alarm.
}, "less-than-equal": "string", Less than equal
"range": "string", Range
"greater-than-equal": "string", Greater than equal
"less-than": "string", Less than
"greater-than": "string" Greater than
}, "average": "integer", Trigger averaged over N intervals.
"immediate": [ null ] Immediate trigger.
}
},
"criterion-delay-factor": [ null ], React criterion delay factor.
"descrition": "string", String describing the react statement. "syslog": [ null ], Syslog.
"snmp": [ null ] SNMP.
},
"criterion-mrv": [ null ] React criterion mrv.
}, "unit": "string", Remaining bandwidth units.
"value": "integer" Remaining bandwidth value.
}, "units": "string", Rate units.
"value": "integer" Remaining bandwidth value.
}
},
"pbr-drop": [ null ], Policy action PBR drop.
"priority-level": "integer", Priority level.
range: "1..7"
"service-fragment": "string", Policy action service fragment.\nService fragment name "unit": "string", Remaining bandwidth units.
"value": "integer" Remaining bandwidth value.
}, "Transmit": [ null ], Police action transmit.
"drop": [ null ], Police action drop. "dei": "integer", DEI based WRED.\nShould be value 0..1.
range: "0..1"
"cos": "integer", WRED based on CoS.
range: "0..7"
"inner-cos": "integer", Set inner cos.
range: "0..7"
"forward-class": "integer", Sets the forward class.
range: "0..7"
"precedence": "string", WRED based on precedence.
range: "0..7"
"srp-priority": "integer", Sets the spatial reuse protocol priority value of an\noutgoing packet.
range: "0..7"
"df": "integer", Set DF bit.
range: "0..1"
"fr-de": "integer", Set FrameRelay DE bit.
range: "0..1"
"dscp-tunnel": "string", Marks a packet by setting DSCP in the tunnel header.\nThis is specific to ipsec tunnels
"mpls-experimental-top-most": "integer", Sets the experimental value of the MPLS packet top-most\nlabels.
range: "0..7"
"dscp": "string", WRED based on DSCP.
"mpls-experimental-imposition": "integer", Sets the experimental value of the MPLS packet\nimposition labels.\nImposition can be used only in service policies that\nare attached in the ingress policy
range: "0..7"
"qos-group": "integer", Sets the QoS group identifiers on IPv4 or MPLS packets.\nThe set qos-group is supported only on an ingress policy.
range: "0..512"
"traffic-class": "integer", Sets the Traffic class identifiers on IPv4 or MPLS packets.
range: "0..63"
"destination-address": "string", Destination IPv4 address.
"precedence-tunnel": "string", Sets the precedence tunnel value for ipsec.
range: "0..7"
"source-address": "string", Source IPv4 address.
"discard-class": "integer", WRED based on discard class.
range: "0..7"
"dei-imposition": "integer", Set DEI imposition bit.
range: "0..1"
"atm-clp": [ null ] Set atm cell-loss-priority bit.
}
}, "units": "string", Rate units.
"value": "integer" Remaining bandwidth value.
}, "units": "string", Rate units.
"value": "integer" Remaining bandwidth value.
}, "units": "string", Rate units.
"value": "integer" Remaining bandwidth value.
}, "Transmit": [ null ], Police action transmit.
"drop": [ null ], Police action drop. "dei": "integer", DEI based WRED.\nShould be value 0..1.
range: "0..1"
"cos": "integer", WRED based on CoS.
range: "0..7"
"inner-cos": "integer", Set inner cos.
range: "0..7"
"forward-class": "integer", Sets the forward class.
range: "0..7"
"precedence": "string", WRED based on precedence.
range: "0..7"
"srp-priority": "integer", Sets the spatial reuse protocol priority value of an\noutgoing packet.
range: "0..7"
"df": "integer", Set DF bit.
range: "0..1"
"fr-de": "integer", Set FrameRelay DE bit.
range: "0..1"
"dscp-tunnel": "string", Marks a packet by setting DSCP in the tunnel header.\nThis is specific to ipsec tunnels
"mpls-experimental-top-most": "integer", Sets the experimental value of the MPLS packet top-most\nlabels.
range: "0..7"
"dscp": "string", WRED based on DSCP.
"mpls-experimental-imposition": "integer", Sets the experimental value of the MPLS packet\nimposition labels.\nImposition can be used only in service policies that\nare attached in the ingress policy
range: "0..7"
"qos-group": "integer", Sets the QoS group identifiers on IPv4 or MPLS packets.\nThe set qos-group is supported only on an ingress policy.
range: "0..512"
"traffic-class": "integer", Sets the Traffic class identifiers on IPv4 or MPLS packets.
range: "0..63"
"destination-address": "string", Destination IPv4 address.
"precedence-tunnel": "string", Sets the precedence tunnel value for ipsec.
range: "0..7"
"source-address": "string", Source IPv4 address.
"discard-class": "integer", WRED based on discard class.
range: "0..7"
"dei-imposition": "integer", Set DEI imposition bit.
range: "0..1"
"atm-clp": [ null ] Set atm cell-loss-priority bit.
}
}, "units": "string", Rate units.
"value": "integer" Remaining bandwidth value.
}, "Transmit": [ null ], Police action transmit.
"drop": [ null ], Police action drop. "dei": "integer", DEI based WRED.\nShould be value 0..1.
range: "0..1"
"cos": "integer", WRED based on CoS.
range: "0..7"
"inner-cos": "integer", Set inner cos.
range: "0..7"
"forward-class": "integer", Sets the forward class.
range: "0..7"
"precedence": "string", WRED based on precedence.
range: "0..7"
"srp-priority": "integer", Sets the spatial reuse protocol priority value of an\noutgoing packet.
range: "0..7"
"df": "integer", Set DF bit.
range: "0..1"
"fr-de": "integer", Set FrameRelay DE bit.
range: "0..1"
"dscp-tunnel": "string", Marks a packet by setting DSCP in the tunnel header.\nThis is specific to ipsec tunnels
"mpls-experimental-top-most": "integer", Sets the experimental value of the MPLS packet top-most\nlabels.
range: "0..7"
"dscp": "string", WRED based on DSCP.
"mpls-experimental-imposition": "integer", Sets the experimental value of the MPLS packet\nimposition labels.\nImposition can be used only in service policies that\nare attached in the ingress policy
range: "0..7"
"qos-group": "integer", Sets the QoS group identifiers on IPv4 or MPLS packets.\nThe set qos-group is supported only on an ingress policy.
range: "0..512"
"traffic-class": "integer", Sets the Traffic class identifiers on IPv4 or MPLS packets.
range: "0..63"
"destination-address": "string", Destination IPv4 address.
"precedence-tunnel": "string", Sets the precedence tunnel value for ipsec.
range: "0..7"
"source-address": "string", Source IPv4 address.
"discard-class": "integer", WRED based on discard class.
range: "0..7"
"dei-imposition": "integer", Set DEI imposition bit.
range: "0..1"
"atm-clp": [ null ] Set atm cell-loss-priority bit.
}
}
}, "subscriberip": [ null ], Subscriber IP
"hostname": [ null ], Hostname
"subscribermac": [ null ], Subscriber Mac
"bngidentifierinterface": [ null ] Bng Identifier Interface
}, "layer3": "integer", Nominal rate specified at the L3 (IP).
units: "bps"
"media": "integer", Nominal data rate of the media flow (ip payload).
range: "1..3000000000"
units: "bps"
"packet": "integer" Nominal IP layer packet rate (in pps).
units: "pps"
}, "count-in-layer3": "integer", Nominal number of media packets in an IP payload.
range: "1..64"
units: "packets"
"size": "integer" Nominal size of the media-packet.
units: "bytes"
}
}, "flow-idle-timeout": "string", The interval after which a flow is removed,\nif there is no activity.\nIf timeout is 0 this flow does not expire. "units": "string", Rate units.
"value": "integer" Remaining bandwidth value.
range: "1..4294967295"
}, "units": "string", Rate units.
"value": "integer" Remaining bandwidth value.
range: "1..4294967295"
}
}, "unit": "string", Remaining bandwidth units.
"value": "integer" Remaining bandwidth value.
},
"http-redirect": "string", Policy action http redirect.\nRedirect to this url. "default": [ null ], Use system default routing table. : { "ipv6-address": "string", IPv6 address.
"ipv4-address": "string", IPv4 address.
"vrf": "string" VRF name.
}
}, "max-flow": "integer", Max simultaneous flows monitored per policy class
range: "0..4096"
"interval-duration": "integer", Monitored interval duration.
units: "seconds"
"timeout": "integer", Declare a flow dead if no packets received in\nso much time
units: "seconds"
"history": "integer" Keep stats/metrics on box for so many intervals.
},
"class-type": "enumeration", Type of class-map.
Options:
qos
traffic
subscriber-control "policy-name": "string", Name of service-policy.
"type": "string" Type of service-policy.
}, "unit": "string", Remaining bandwidth units.
"value": "integer" Remaining bandwidth value.
},
"decap-gre": [ null ], Policy action DECAP GRE. {
"cos": "string", WRED based on CoS.
range: "0..7"
"threshold-max-value": "integer", Maximum RED threshold value.
"precedence": "string", WRED based on precedence.
range: "0..7"
"threshold-min-value": "integer", Minimum RED threshold value.
"threshold-max-units": "string", Maximum RED threshold units.
"dscp": "string", WRED based on DSCP.
"dei": "integer", DEI based WRED.\nShould be value 0..1.
range: "0..1"
"threshold-min-units": "string", Minimum RED threshold units.
"ecn": [ null ], ECN based WRED.
"discard-class": "string", WRED based on discard class.
range: "0..7"
"mpls-exp": "string" MPLS Experimental value based WRED.
range: "0..7"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
POLICY-MAP-RULE - Create
Create operation of resource: policy-map-rule
policy-map-rulebody object
ID of type name
ID of class-name class-type
Request Content-Types: application/json
Request Example
{ "unit": "string", Remaining bandwidth units.
"value": "integer" Remaining bandwidth value.
}, "unit": "string", Remaining bandwidth units.
"value": "integer" Remaining bandwidth value.
},
"pfc-pause-set": [ null ], Pfc Pause set value. "unit": "string", Remaining bandwidth units.
"value": "integer" Remaining bandwidth value.
}
}, "index": "integer", ASN2:index 2/4 byte (hex or decimal format)
range: "1..255"
"path-id": "integer", Service function path id.
range: "1..16777215"
"metadata": "string" Service function path metadata name.
},
"default-red": [ null ], Default random early detection
"pbr-transmit": [ null ], Policy action PBR transmit.
"fragment": "string", Policy action fragment. Fragment name "dei": "integer", DEI based WRED.\nShould be value 0..1.
range: "0..1"
"cos": "integer", WRED based on CoS.
range: "0..7"
"inner-cos": "integer", Set inner cos.
range: "0..7"
"forward-class": "integer", Sets the forward class.
range: "0..7"
"precedence": "string", WRED based on precedence.
range: "0..7"
"srp-priority": "integer", Sets the spatial reuse protocol priority value of an\noutgoing packet.
range: "0..7"
"df": "integer", Set DF bit.
range: "0..1"
"fr-de": "integer", Set FrameRelay DE bit.
range: "0..1"
"dscp-tunnel": "string", Marks a packet by setting DSCP in the tunnel header.\nThis is specific to ipsec tunnels
"mpls-experimental-top-most": "integer", Sets the experimental value of the MPLS packet top-most\nlabels.
range: "0..7"
"dscp": "string", WRED based on DSCP.
"mpls-experimental-imposition": "integer", Sets the experimental value of the MPLS packet\nimposition labels.\nImposition can be used only in service policies that\nare attached in the ingress policy
range: "0..7"
"qos-group": "integer", Sets the QoS group identifiers on IPv4 or MPLS packets.\nThe set qos-group is supported only on an ingress policy.
range: "0..512"
"traffic-class": "integer", Sets the Traffic class identifiers on IPv4 or MPLS packets.
range: "0..63"
"destination-address": "string", Destination IPv4 address.
"precedence-tunnel": "string", Sets the precedence tunnel value for ipsec.
range: "0..7"
"source-address": "string", Source IPv4 address.
"discard-class": "integer", WRED based on discard class.
range: "0..7"
"dei-imposition": "integer", Set DEI imposition bit.
range: "0..1"
"atm-clp": [ null ] Set atm cell-loss-priority bit.
}, "index": "integer", ASN2:index 2/4 byte (hex or decimal format)
range: "0..4294967295" "netmask": "string", IPv4 netmask.
"address": "string" IPv4 address.
},
"as-number": "integer" 2-byte/4-byte AS number
range: "1..4294967295"
}
}, "ipv4-next-hop": "string", IPv4 address.
"vrf": "string" VRF name.
}, "ipv6-next-hop": "string", IPv6 address.
"vrf": "string" VRF name.
}
},
"class-name": "string", Name of class-map.
"ecn-red": [ null ], ECN based random early detection "criterion-packet-rate": [ null ], React criterion packet rate.
"criterion-media-stop": [ null ], React criterion media stop.
"criterion-flow-count": [ null ], React criterion flow count. "group-count": "integer", Number of flows to reach before\ntriggering alarm
units: "number of flows"
"discrete": [ null ], Discrete alarm type.
"group-percent": "integer" Percent to reach before triggering alarm
units: "percentage"
},
"severity": "string" Severity of the alarm.
}, "less-than-equal": "string", Less than equal
"range": "string", Range
"greater-than-equal": "string", Greater than equal
"less-than": "string", Less than
"greater-than": "string" Greater than
}, "average": "integer", Trigger averaged over N intervals.
"immediate": [ null ] Immediate trigger.
}
},
"criterion-delay-factor": [ null ], React criterion delay factor.
"descrition": "string", String describing the react statement. "syslog": [ null ], Syslog.
"snmp": [ null ] SNMP.
},
"criterion-mrv": [ null ] React criterion mrv.
}, "unit": "string", Remaining bandwidth units.
"value": "integer" Remaining bandwidth value.
}, "units": "string", Rate units.
"value": "integer" Remaining bandwidth value.
}
},
"pbr-drop": [ null ], Policy action PBR drop.
"priority-level": "integer", Priority level.
range: "1..7"
"service-fragment": "string", Policy action service fragment.\nService fragment name "unit": "string", Remaining bandwidth units.
"value": "integer" Remaining bandwidth value.
}, "Transmit": [ null ], Police action transmit.
"drop": [ null ], Police action drop. "dei": "integer", DEI based WRED.\nShould be value 0..1.
range: "0..1"
"cos": "integer", WRED based on CoS.
range: "0..7"
"inner-cos": "integer", Set inner cos.
range: "0..7"
"forward-class": "integer", Sets the forward class.
range: "0..7"
"precedence": "string", WRED based on precedence.
range: "0..7"
"srp-priority": "integer", Sets the spatial reuse protocol priority value of an\noutgoing packet.
range: "0..7"
"df": "integer", Set DF bit.
range: "0..1"
"fr-de": "integer", Set FrameRelay DE bit.
range: "0..1"
"dscp-tunnel": "string", Marks a packet by setting DSCP in the tunnel header.\nThis is specific to ipsec tunnels
"mpls-experimental-top-most": "integer", Sets the experimental value of the MPLS packet top-most\nlabels.
range: "0..7"
"dscp": "string", WRED based on DSCP.
"mpls-experimental-imposition": "integer", Sets the experimental value of the MPLS packet\nimposition labels.\nImposition can be used only in service policies that\nare attached in the ingress policy
range: "0..7"
"qos-group": "integer", Sets the QoS group identifiers on IPv4 or MPLS packets.\nThe set qos-group is supported only on an ingress policy.
range: "0..512"
"traffic-class": "integer", Sets the Traffic class identifiers on IPv4 or MPLS packets.
range: "0..63"
"destination-address": "string", Destination IPv4 address.
"precedence-tunnel": "string", Sets the precedence tunnel value for ipsec.
range: "0..7"
"source-address": "string", Source IPv4 address.
"discard-class": "integer", WRED based on discard class.
range: "0..7"
"dei-imposition": "integer", Set DEI imposition bit.
range: "0..1"
"atm-clp": [ null ] Set atm cell-loss-priority bit.
}
}, "units": "string", Rate units.
"value": "integer" Remaining bandwidth value.
}, "units": "string", Rate units.
"value": "integer" Remaining bandwidth value.
}, "units": "string", Rate units.
"value": "integer" Remaining bandwidth value.
}, "Transmit": [ null ], Police action transmit.
"drop": [ null ], Police action drop. "dei": "integer", DEI based WRED.\nShould be value 0..1.
range: "0..1"
"cos": "integer", WRED based on CoS.
range: "0..7"
"inner-cos": "integer", Set inner cos.
range: "0..7"
"forward-class": "integer", Sets the forward class.
range: "0..7"
"precedence": "string", WRED based on precedence.
range: "0..7"
"srp-priority": "integer", Sets the spatial reuse protocol priority value of an\noutgoing packet.
range: "0..7"
"df": "integer", Set DF bit.
range: "0..1"
"fr-de": "integer", Set FrameRelay DE bit.
range: "0..1"
"dscp-tunnel": "string", Marks a packet by setting DSCP in the tunnel header.\nThis is specific to ipsec tunnels
"mpls-experimental-top-most": "integer", Sets the experimental value of the MPLS packet top-most\nlabels.
range: "0..7"
"dscp": "string", WRED based on DSCP.
"mpls-experimental-imposition": "integer", Sets the experimental value of the MPLS packet\nimposition labels.\nImposition can be used only in service policies that\nare attached in the ingress policy
range: "0..7"
"qos-group": "integer", Sets the QoS group identifiers on IPv4 or MPLS packets.\nThe set qos-group is supported only on an ingress policy.
range: "0..512"
"traffic-class": "integer", Sets the Traffic class identifiers on IPv4 or MPLS packets.
range: "0..63"
"destination-address": "string", Destination IPv4 address.
"precedence-tunnel": "string", Sets the precedence tunnel value for ipsec.
range: "0..7"
"source-address": "string", Source IPv4 address.
"discard-class": "integer", WRED based on discard class.
range: "0..7"
"dei-imposition": "integer", Set DEI imposition bit.
range: "0..1"
"atm-clp": [ null ] Set atm cell-loss-priority bit.
}
}, "units": "string", Rate units.
"value": "integer" Remaining bandwidth value.
}, "Transmit": [ null ], Police action transmit.
"drop": [ null ], Police action drop. "dei": "integer", DEI based WRED.\nShould be value 0..1.
range: "0..1"
"cos": "integer", WRED based on CoS.
range: "0..7"
"inner-cos": "integer", Set inner cos.
range: "0..7"
"forward-class": "integer", Sets the forward class.
range: "0..7"
"precedence": "string", WRED based on precedence.
range: "0..7"
"srp-priority": "integer", Sets the spatial reuse protocol priority value of an\noutgoing packet.
range: "0..7"
"df": "integer", Set DF bit.
range: "0..1"
"fr-de": "integer", Set FrameRelay DE bit.
range: "0..1"
"dscp-tunnel": "string", Marks a packet by setting DSCP in the tunnel header.\nThis is specific to ipsec tunnels
"mpls-experimental-top-most": "integer", Sets the experimental value of the MPLS packet top-most\nlabels.
range: "0..7"
"dscp": "string", WRED based on DSCP.
"mpls-experimental-imposition": "integer", Sets the experimental value of the MPLS packet\nimposition labels.\nImposition can be used only in service policies that\nare attached in the ingress policy
range: "0..7"
"qos-group": "integer", Sets the QoS group identifiers on IPv4 or MPLS packets.\nThe set qos-group is supported only on an ingress policy.
range: "0..512"
"traffic-class": "integer", Sets the Traffic class identifiers on IPv4 or MPLS packets.
range: "0..63"
"destination-address": "string", Destination IPv4 address.
"precedence-tunnel": "string", Sets the precedence tunnel value for ipsec.
range: "0..7"
"source-address": "string", Source IPv4 address.
"discard-class": "integer", WRED based on discard class.
range: "0..7"
"dei-imposition": "integer", Set DEI imposition bit.
range: "0..1"
"atm-clp": [ null ] Set atm cell-loss-priority bit.
}
}
}, "subscriberip": [ null ], Subscriber IP
"hostname": [ null ], Hostname
"subscribermac": [ null ], Subscriber Mac
"bngidentifierinterface": [ null ] Bng Identifier Interface
}, "layer3": "integer", Nominal rate specified at the L3 (IP).
units: "bps"
"media": "integer", Nominal data rate of the media flow (ip payload).
range: "1..3000000000"
units: "bps"
"packet": "integer" Nominal IP layer packet rate (in pps).
units: "pps"
}, "count-in-layer3": "integer", Nominal number of media packets in an IP payload.
range: "1..64"
units: "packets"
"size": "integer" Nominal size of the media-packet.
units: "bytes"
}
}, "flow-idle-timeout": "string", The interval after which a flow is removed,\nif there is no activity.\nIf timeout is 0 this flow does not expire. "units": "string", Rate units.
"value": "integer" Remaining bandwidth value.
range: "1..4294967295"
}, "units": "string", Rate units.
"value": "integer" Remaining bandwidth value.
range: "1..4294967295"
}
}, "unit": "string", Remaining bandwidth units.
"value": "integer" Remaining bandwidth value.
},
"http-redirect": "string", Policy action http redirect.\nRedirect to this url. "default": [ null ], Use system default routing table. : { "ipv6-address": "string", IPv6 address.
"ipv4-address": "string", IPv4 address.
"vrf": "string" VRF name.
}
}, "max-flow": "integer", Max simultaneous flows monitored per policy class
range: "0..4096"
"interval-duration": "integer", Monitored interval duration.
units: "seconds"
"timeout": "integer", Declare a flow dead if no packets received in\nso much time
units: "seconds"
"history": "integer" Keep stats/metrics on box for so many intervals.
},
"class-type": "enumeration", Type of class-map.
Options:
qos
traffic
subscriber-control "policy-name": "string", Name of service-policy.
"type": "string" Type of service-policy.
}, "unit": "string", Remaining bandwidth units.
"value": "integer" Remaining bandwidth value.
},
"decap-gre": [ null ], Policy action DECAP GRE. {
"cos": "string", WRED based on CoS.
range: "0..7"
"threshold-max-value": "integer", Maximum RED threshold value.
"precedence": "string", WRED based on precedence.
range: "0..7"
"threshold-min-value": "integer", Minimum RED threshold value.
"threshold-max-units": "string", Maximum RED threshold units.
"dscp": "string", WRED based on DSCP.
"dei": "integer", DEI based WRED.\nShould be value 0..1.
range: "0..1"
"threshold-min-units": "string", Minimum RED threshold units.
"ecn": [ null ], ECN based WRED.
"discard-class": "string", WRED based on discard class.
range: "0..7"
"mpls-exp": "string" MPLS Experimental value based WRED.
range: "0..7"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
POLICY-MAP-RULE - Delete
Delete operation of resource: policy-map-rule
ID of type name
ID of class-name class-type
Successful operation
Internal Error
Response Content-Types: application/json
POLICY-MAP-RULE - Retrieve
Retrieve operation of resource: policy-map-rule
ID of type name
ID of class-name class-type
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "unit": "string", Remaining bandwidth units.
"value": "integer" Remaining bandwidth value.
}, "unit": "string", Remaining bandwidth units.
"value": "integer" Remaining bandwidth value.
},
"pfc-pause-set": [ null ], Pfc Pause set value. "unit": "string", Remaining bandwidth units.
"value": "integer" Remaining bandwidth value.
}
}, "index": "integer", ASN2:index 2/4 byte (hex or decimal format)
range: "1..255"
"path-id": "integer", Service function path id.
range: "1..16777215"
"metadata": "string" Service function path metadata name.
},
"default-red": [ null ], Default random early detection
"pbr-transmit": [ null ], Policy action PBR transmit.
"fragment": "string", Policy action fragment. Fragment name "dei": "integer", DEI based WRED.\nShould be value 0..1.
range: "0..1"
"cos": "integer", WRED based on CoS.
range: "0..7"
"inner-cos": "integer", Set inner cos.
range: "0..7"
"forward-class": "integer", Sets the forward class.
range: "0..7"
"precedence": "string", WRED based on precedence.
range: "0..7"
"srp-priority": "integer", Sets the spatial reuse protocol priority value of an\noutgoing packet.
range: "0..7"
"df": "integer", Set DF bit.
range: "0..1"
"fr-de": "integer", Set FrameRelay DE bit.
range: "0..1"
"dscp-tunnel": "string", Marks a packet by setting DSCP in the tunnel header.\nThis is specific to ipsec tunnels
"mpls-experimental-top-most": "integer", Sets the experimental value of the MPLS packet top-most\nlabels.
range: "0..7"
"dscp": "string", WRED based on DSCP.
"mpls-experimental-imposition": "integer", Sets the experimental value of the MPLS packet\nimposition labels.\nImposition can be used only in service policies that\nare attached in the ingress policy
range: "0..7"
"qos-group": "integer", Sets the QoS group identifiers on IPv4 or MPLS packets.\nThe set qos-group is supported only on an ingress policy.
range: "0..512"
"traffic-class": "integer", Sets the Traffic class identifiers on IPv4 or MPLS packets.
range: "0..63"
"destination-address": "string", Destination IPv4 address.
"precedence-tunnel": "string", Sets the precedence tunnel value for ipsec.
range: "0..7"
"source-address": "string", Source IPv4 address.
"discard-class": "integer", WRED based on discard class.
range: "0..7"
"dei-imposition": "integer", Set DEI imposition bit.
range: "0..1"
"atm-clp": [ null ] Set atm cell-loss-priority bit.
}, "index": "integer", ASN2:index 2/4 byte (hex or decimal format)
range: "0..4294967295" "netmask": "string", IPv4 netmask.
"address": "string" IPv4 address.
},
"as-number": "integer" 2-byte/4-byte AS number
range: "1..4294967295"
}
}, "ipv4-next-hop": "string", IPv4 address.
"vrf": "string" VRF name.
}, "ipv6-next-hop": "string", IPv6 address.
"vrf": "string" VRF name.
}
},
"class-name": "string", Name of class-map.
"ecn-red": [ null ], ECN based random early detection "criterion-packet-rate": [ null ], React criterion packet rate.
"criterion-media-stop": [ null ], React criterion media stop.
"criterion-flow-count": [ null ], React criterion flow count. "group-count": "integer", Number of flows to reach before\ntriggering alarm
units: "number of flows"
"discrete": [ null ], Discrete alarm type.
"group-percent": "integer" Percent to reach before triggering alarm
units: "percentage"
},
"severity": "string" Severity of the alarm.
}, "less-than-equal": "string", Less than equal
"range": "string", Range
"greater-than-equal": "string", Greater than equal
"less-than": "string", Less than
"greater-than": "string" Greater than
}, "average": "integer", Trigger averaged over N intervals.
"immediate": [ null ] Immediate trigger.
}
},
"criterion-delay-factor": [ null ], React criterion delay factor.
"descrition": "string", String describing the react statement. "syslog": [ null ], Syslog.
"snmp": [ null ] SNMP.
},
"criterion-mrv": [ null ] React criterion mrv.
}, "unit": "string", Remaining bandwidth units.
"value": "integer" Remaining bandwidth value.
}, "units": "string", Rate units.
"value": "integer" Remaining bandwidth value.
}
},
"pbr-drop": [ null ], Policy action PBR drop.
"priority-level": "integer", Priority level.
range: "1..7"
"service-fragment": "string", Policy action service fragment.\nService fragment name "unit": "string", Remaining bandwidth units.
"value": "integer" Remaining bandwidth value.
}, "Transmit": [ null ], Police action transmit.
"drop": [ null ], Police action drop. "dei": "integer", DEI based WRED.\nShould be value 0..1.
range: "0..1"
"cos": "integer", WRED based on CoS.
range: "0..7"
"inner-cos": "integer", Set inner cos.
range: "0..7"
"forward-class": "integer", Sets the forward class.
range: "0..7"
"precedence": "string", WRED based on precedence.
range: "0..7"
"srp-priority": "integer", Sets the spatial reuse protocol priority value of an\noutgoing packet.
range: "0..7"
"df": "integer", Set DF bit.
range: "0..1"
"fr-de": "integer", Set FrameRelay DE bit.
range: "0..1"
"dscp-tunnel": "string", Marks a packet by setting DSCP in the tunnel header.\nThis is specific to ipsec tunnels
"mpls-experimental-top-most": "integer", Sets the experimental value of the MPLS packet top-most\nlabels.
range: "0..7"
"dscp": "string", WRED based on DSCP.
"mpls-experimental-imposition": "integer", Sets the experimental value of the MPLS packet\nimposition labels.\nImposition can be used only in service policies that\nare attached in the ingress policy
range: "0..7"
"qos-group": "integer", Sets the QoS group identifiers on IPv4 or MPLS packets.\nThe set qos-group is supported only on an ingress policy.
range: "0..512"
"traffic-class": "integer", Sets the Traffic class identifiers on IPv4 or MPLS packets.
range: "0..63"
"destination-address": "string", Destination IPv4 address.
"precedence-tunnel": "string", Sets the precedence tunnel value for ipsec.
range: "0..7"
"source-address": "string", Source IPv4 address.
"discard-class": "integer", WRED based on discard class.
range: "0..7"
"dei-imposition": "integer", Set DEI imposition bit.
range: "0..1"
"atm-clp": [ null ] Set atm cell-loss-priority bit.
}
}, "units": "string", Rate units.
"value": "integer" Remaining bandwidth value.
}, "units": "string", Rate units.
"value": "integer" Remaining bandwidth value.
}, "units": "string", Rate units.
"value": "integer" Remaining bandwidth value.
}, "Transmit": [ null ], Police action transmit.
"drop": [ null ], Police action drop. "dei": "integer", DEI based WRED.\nShould be value 0..1.
range: "0..1"
"cos": "integer", WRED based on CoS.
range: "0..7"
"inner-cos": "integer", Set inner cos.
range: "0..7"
"forward-class": "integer", Sets the forward class.
range: "0..7"
"precedence": "string", WRED based on precedence.
range: "0..7"
"srp-priority": "integer", Sets the spatial reuse protocol priority value of an\noutgoing packet.
range: "0..7"
"df": "integer", Set DF bit.
range: "0..1"
"fr-de": "integer", Set FrameRelay DE bit.
range: "0..1"
"dscp-tunnel": "string", Marks a packet by setting DSCP in the tunnel header.\nThis is specific to ipsec tunnels
"mpls-experimental-top-most": "integer", Sets the experimental value of the MPLS packet top-most\nlabels.
range: "0..7"
"dscp": "string", WRED based on DSCP.
"mpls-experimental-imposition": "integer", Sets the experimental value of the MPLS packet\nimposition labels.\nImposition can be used only in service policies that\nare attached in the ingress policy
range: "0..7"
"qos-group": "integer", Sets the QoS group identifiers on IPv4 or MPLS packets.\nThe set qos-group is supported only on an ingress policy.
range: "0..512"
"traffic-class": "integer", Sets the Traffic class identifiers on IPv4 or MPLS packets.
range: "0..63"
"destination-address": "string", Destination IPv4 address.
"precedence-tunnel": "string", Sets the precedence tunnel value for ipsec.
range: "0..7"
"source-address": "string", Source IPv4 address.
"discard-class": "integer", WRED based on discard class.
range: "0..7"
"dei-imposition": "integer", Set DEI imposition bit.
range: "0..1"
"atm-clp": [ null ] Set atm cell-loss-priority bit.
}
}, "units": "string", Rate units.
"value": "integer" Remaining bandwidth value.
}, "Transmit": [ null ], Police action transmit.
"drop": [ null ], Police action drop. "dei": "integer", DEI based WRED.\nShould be value 0..1.
range: "0..1"
"cos": "integer", WRED based on CoS.
range: "0..7"
"inner-cos": "integer", Set inner cos.
range: "0..7"
"forward-class": "integer", Sets the forward class.
range: "0..7"
"precedence": "string", WRED based on precedence.
range: "0..7"
"srp-priority": "integer", Sets the spatial reuse protocol priority value of an\noutgoing packet.
range: "0..7"
"df": "integer", Set DF bit.
range: "0..1"
"fr-de": "integer", Set FrameRelay DE bit.
range: "0..1"
"dscp-tunnel": "string", Marks a packet by setting DSCP in the tunnel header.\nThis is specific to ipsec tunnels
"mpls-experimental-top-most": "integer", Sets the experimental value of the MPLS packet top-most\nlabels.
range: "0..7"
"dscp": "string", WRED based on DSCP.
"mpls-experimental-imposition": "integer", Sets the experimental value of the MPLS packet\nimposition labels.\nImposition can be used only in service policies that\nare attached in the ingress policy
range: "0..7"
"qos-group": "integer", Sets the QoS group identifiers on IPv4 or MPLS packets.\nThe set qos-group is supported only on an ingress policy.
range: "0..512"
"traffic-class": "integer", Sets the Traffic class identifiers on IPv4 or MPLS packets.
range: "0..63"
"destination-address": "string", Destination IPv4 address.
"precedence-tunnel": "string", Sets the precedence tunnel value for ipsec.
range: "0..7"
"source-address": "string", Source IPv4 address.
"discard-class": "integer", WRED based on discard class.
range: "0..7"
"dei-imposition": "integer", Set DEI imposition bit.
range: "0..1"
"atm-clp": [ null ] Set atm cell-loss-priority bit.
}
}
}, "subscriberip": [ null ], Subscriber IP
"hostname": [ null ], Hostname
"subscribermac": [ null ], Subscriber Mac
"bngidentifierinterface": [ null ] Bng Identifier Interface
}, "layer3": "integer", Nominal rate specified at the L3 (IP).
units: "bps"
"media": "integer", Nominal data rate of the media flow (ip payload).
range: "1..3000000000"
units: "bps"
"packet": "integer" Nominal IP layer packet rate (in pps).
units: "pps"
}, "count-in-layer3": "integer", Nominal number of media packets in an IP payload.
range: "1..64"
units: "packets"
"size": "integer" Nominal size of the media-packet.
units: "bytes"
}
}, "flow-idle-timeout": "string", The interval after which a flow is removed,\nif there is no activity.\nIf timeout is 0 this flow does not expire. "units": "string", Rate units.
"value": "integer" Remaining bandwidth value.
range: "1..4294967295"
}, "units": "string", Rate units.
"value": "integer" Remaining bandwidth value.
range: "1..4294967295"
}
}, "unit": "string", Remaining bandwidth units.
"value": "integer" Remaining bandwidth value.
},
"http-redirect": "string", Policy action http redirect.\nRedirect to this url. "default": [ null ], Use system default routing table. : { "ipv6-address": "string", IPv6 address.
"ipv4-address": "string", IPv4 address.
"vrf": "string" VRF name.
}
}, "max-flow": "integer", Max simultaneous flows monitored per policy class
range: "0..4096"
"interval-duration": "integer", Monitored interval duration.
units: "seconds"
"timeout": "integer", Declare a flow dead if no packets received in\nso much time
units: "seconds"
"history": "integer" Keep stats/metrics on box for so many intervals.
},
"class-type": "enumeration", Type of class-map.
Options:
qos
traffic
subscriber-control "policy-name": "string", Name of service-policy.
"type": "string" Type of service-policy.
}, "unit": "string", Remaining bandwidth units.
"value": "integer" Remaining bandwidth value.
},
"decap-gre": [ null ], Policy action DECAP GRE. {
"cos": "string", WRED based on CoS.
range: "0..7"
"threshold-max-value": "integer", Maximum RED threshold value.
"precedence": "string", WRED based on precedence.
range: "0..7"
"threshold-min-value": "integer", Minimum RED threshold value.
"threshold-max-units": "string", Maximum RED threshold units.
"dscp": "string", WRED based on DSCP.
"dei": "integer", DEI based WRED.\nShould be value 0..1.
range: "0..1"
"threshold-min-units": "string", Minimum RED threshold units.
"ecn": [ null ], ECN based WRED.
"discard-class": "string", WRED based on discard class.
range: "0..7"
"mpls-exp": "string" MPLS Experimental value based WRED.
range: "0..7"
}
]
}
}
SHAPE - Update
Update operation of resource: shape
shapebody object
ID of type name
ID of class-name class-type
Request Content-Types: application/json
Request Example
{ "unit": "string", Shape bandwidth units.
"value": "integer" Burst size value.
}, "units": "string", Burst size units.
"value": "integer" Burst size value.
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
SHAPE - Create
Create operation of resource: shape
shapebody object
ID of type name
ID of class-name class-type
Request Content-Types: application/json
Request Example
{ "unit": "string", Shape bandwidth units.
"value": "integer" Burst size value.
}, "units": "string", Burst size units.
"value": "integer" Burst size value.
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
SHAPE - Delete
Delete operation of resource: shape
ID of type name
ID of class-name class-type
Successful operation
Internal Error
Response Content-Types: application/json
SHAPE - Retrieve
Retrieve operation of resource: shape
ID of type name
ID of class-name class-type
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "unit": "string", Shape bandwidth units.
"value": "integer" Burst size value.
}, "units": "string", Burst size units.
"value": "integer" Burst size value.
}
}
}
RATE - Update
Update operation of resource: rate
ratebody object
ID of type name
ID of class-name class-type
Successful operation
Internal Error
Response Content-Types: application/json
RATE - Create
Create operation of resource: rate
ratebody object
ID of type name
ID of class-name class-type
Successful operation
Internal Error
Response Content-Types: application/json
RATE - Delete
Delete operation of resource: rate
ID of type name
ID of class-name class-type
Successful operation
Internal Error
Response Content-Types: application/json
RATE - Retrieve
Retrieve operation of resource: rate
ID of type name
ID of class-name class-type
Successful operation
Internal Error
BURST - Update
Update operation of resource: burst
burstbody object
ID of type name
ID of class-name class-type
Successful operation
Internal Error
Response Content-Types: application/json
BURST - Create
Create operation of resource: burst
burstbody object
ID of type name
ID of class-name class-type
Successful operation
Internal Error
Response Content-Types: application/json
BURST - Delete
Delete operation of resource: burst
ID of type name
ID of class-name class-type
Successful operation
Internal Error
Response Content-Types: application/json
BURST - Retrieve
Retrieve operation of resource: burst
ID of type name
ID of class-name class-type
Successful operation
Internal Error
MIN-BANDWIDTH - Update
Update operation of resource: min-bandwidth
min-bandwidthbody object
ID of type name
ID of class-name class-type
Successful operation
Internal Error
Response Content-Types: application/json
MIN-BANDWIDTH - Create
Create operation of resource: min-bandwidth
min-bandwidthbody object
ID of type name
ID of class-name class-type
Successful operation
Internal Error
Response Content-Types: application/json
MIN-BANDWIDTH - Delete
Delete operation of resource: min-bandwidth
ID of type name
ID of class-name class-type
Successful operation
Internal Error
Response Content-Types: application/json
MIN-BANDWIDTH - Retrieve
Retrieve operation of resource: min-bandwidth
ID of type name
ID of class-name class-type
Successful operation
Internal Error
BANDWIDTH-REMAINING - Update
Update operation of resource: bandwidth-remaining
bandwidth-remainingbody object
ID of type name
ID of class-name class-type
Successful operation
Internal Error
Response Content-Types: application/json
BANDWIDTH-REMAINING - Create
Create operation of resource: bandwidth-remaining
bandwidth-remainingbody object
ID of type name
ID of class-name class-type
Successful operation
Internal Error
Response Content-Types: application/json
BANDWIDTH-REMAINING - Delete
Delete operation of resource: bandwidth-remaining
ID of type name
ID of class-name class-type
Successful operation
Internal Error
Response Content-Types: application/json
BANDWIDTH-REMAINING - Retrieve
Retrieve operation of resource: bandwidth-remaining
ID of type name
ID of class-name class-type
Successful operation
Internal Error
QUEUE-LIMIT - Update
Update operation of resource: queue-limit
queue-limitbody object
ID of type name
ID of class-name class-type
Successful operation
Internal Error
Response Content-Types: application/json
QUEUE-LIMIT - Create
Create operation of resource: queue-limit
queue-limitbody object
ID of type name
ID of class-name class-type
Successful operation
Internal Error
Response Content-Types: application/json
QUEUE-LIMIT - Delete
Delete operation of resource: queue-limit
ID of type name
ID of class-name class-type
Successful operation
Internal Error
Response Content-Types: application/json
QUEUE-LIMIT - Retrieve
Retrieve operation of resource: queue-limit
ID of type name
ID of class-name class-type
Successful operation
Internal Error
PFC - Update
Update operation of resource: pfc
pfcbody object
ID of type name
ID of class-name class-type
Request Content-Types: application/json
Request Example
{ "unit": "string", Pfc pause threshold units.
"value": "integer" Pfc pause threshold value.
}, "unit": "string", Pfc pause threshold units.
"value": "integer" Pfc pause threshold value.
},
"pfc-pause-set": [ null ], Pfc Pause set value. "unit": "string", Pfc pause threshold units.
"value": "integer" Pfc pause threshold value.
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
PFC - Create
Create operation of resource: pfc
pfcbody object
ID of type name
ID of class-name class-type
Request Content-Types: application/json
Request Example
{ "unit": "string", Pfc pause threshold units.
"value": "integer" Pfc pause threshold value.
}, "unit": "string", Pfc pause threshold units.
"value": "integer" Pfc pause threshold value.
},
"pfc-pause-set": [ null ], Pfc Pause set value. "unit": "string", Pfc pause threshold units.
"value": "integer" Pfc pause threshold value.
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
PFC - Delete
Delete operation of resource: pfc
ID of type name
ID of class-name class-type
Successful operation
Internal Error
Response Content-Types: application/json
PFC - Retrieve
Retrieve operation of resource: pfc
ID of type name
ID of class-name class-type
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "unit": "string", Pfc pause threshold units.
"value": "integer" Pfc pause threshold value.
}, "unit": "string", Pfc pause threshold units.
"value": "integer" Pfc pause threshold value.
},
"pfc-pause-set": [ null ], Pfc Pause set value. "unit": "string", Pfc pause threshold units.
"value": "integer" Pfc pause threshold value.
}
}
}
PFC-BUFFER-SIZE - Update
Update operation of resource: pfc-buffer-size
pfc-buffer-sizebody object
ID of type name
ID of class-name class-type
Successful operation
Internal Error
Response Content-Types: application/json
PFC-BUFFER-SIZE - Create
Create operation of resource: pfc-buffer-size
pfc-buffer-sizebody object
ID of type name
ID of class-name class-type
Successful operation
Internal Error
Response Content-Types: application/json
PFC-BUFFER-SIZE - Delete
Delete operation of resource: pfc-buffer-size
ID of type name
ID of class-name class-type
Successful operation
Internal Error
Response Content-Types: application/json
PFC-BUFFER-SIZE - Retrieve
Retrieve operation of resource: pfc-buffer-size
ID of type name
ID of class-name class-type
Successful operation
Internal Error
PFC-PAUSE-THRESHOLD - Update
Update operation of resource: pfc-pause-threshold
pfc-pause-thresholdbody object
ID of type name
ID of class-name class-type
Successful operation
Internal Error
Response Content-Types: application/json
PFC-PAUSE-THRESHOLD - Create
Create operation of resource: pfc-pause-threshold
pfc-pause-thresholdbody object
ID of type name
ID of class-name class-type
Successful operation
Internal Error
Response Content-Types: application/json
PFC-PAUSE-THRESHOLD - Delete
Delete operation of resource: pfc-pause-threshold
ID of type name
ID of class-name class-type
Successful operation
Internal Error
Response Content-Types: application/json
PFC-PAUSE-THRESHOLD - Retrieve
Retrieve operation of resource: pfc-pause-threshold
ID of type name
ID of class-name class-type
Successful operation
Internal Error
PFC-RESUME-THRESHOLD - Update
Update operation of resource: pfc-resume-threshold
pfc-resume-thresholdbody object
ID of type name
ID of class-name class-type
Successful operation
Internal Error
Response Content-Types: application/json
PFC-RESUME-THRESHOLD - Create
Create operation of resource: pfc-resume-threshold
pfc-resume-thresholdbody object
ID of type name
ID of class-name class-type
Successful operation
Internal Error
Response Content-Types: application/json
PFC-RESUME-THRESHOLD - Delete
Delete operation of resource: pfc-resume-threshold
ID of type name
ID of class-name class-type
Successful operation
Internal Error
Response Content-Types: application/json
PFC-RESUME-THRESHOLD - Retrieve
Retrieve operation of resource: pfc-resume-threshold
ID of type name
ID of class-name class-type
Successful operation
Internal Error
RANDOM-DETECT - Update
Update operation of resource: random-detect
random-detectbody object
ID of type name
ID of class-name class-type
ID of threshold-min-value threshold-min-units threshold-max-value threshold-max-units
Request Content-Types: application/json
Request Example
{ "cos": "string", WRED based on CoS.
range: "0..7"
"threshold-max-value": "integer", Maximum RED threshold value.
"precedence": "string", WRED based on precedence.
range: "0..7"
"threshold-min-value": "integer", Minimum RED threshold value.
"threshold-max-units": "string", Maximum RED threshold units.
"dscp": "string", WRED based on DSCP.
"dei": "integer", DEI based WRED.\nShould be value 0..1.
range: "0..1"
"threshold-min-units": "string", Minimum RED threshold units.
"ecn": [ null ], ECN based WRED.
"discard-class": "string", WRED based on discard class.
range: "0..7"
"mpls-exp": "string" MPLS Experimental value based WRED.
range: "0..7"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
RANDOM-DETECT - Create
Create operation of resource: random-detect
random-detectbody object
ID of type name
ID of class-name class-type
ID of threshold-min-value threshold-min-units threshold-max-value threshold-max-units
Request Content-Types: application/json
Request Example
{ "cos": "string", WRED based on CoS.
range: "0..7"
"threshold-max-value": "integer", Maximum RED threshold value.
"precedence": "string", WRED based on precedence.
range: "0..7"
"threshold-min-value": "integer", Minimum RED threshold value.
"threshold-max-units": "string", Maximum RED threshold units.
"dscp": "string", WRED based on DSCP.
"dei": "integer", DEI based WRED.\nShould be value 0..1.
range: "0..1"
"threshold-min-units": "string", Minimum RED threshold units.
"ecn": [ null ], ECN based WRED.
"discard-class": "string", WRED based on discard class.
range: "0..7"
"mpls-exp": "string" MPLS Experimental value based WRED.
range: "0..7"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
RANDOM-DETECT - Delete
Delete operation of resource: random-detect
ID of type name
ID of class-name class-type
ID of threshold-min-value threshold-min-units threshold-max-value threshold-max-units
Successful operation
Internal Error
Response Content-Types: application/json
RANDOM-DETECT - Retrieve
Retrieve operation of resource: random-detect
ID of type name
ID of class-name class-type
ID of threshold-min-value threshold-min-units threshold-max-value threshold-max-units
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "cos": "string", WRED based on CoS.
range: "0..7"
"threshold-max-value": "integer", Maximum RED threshold value.
"precedence": "string", WRED based on precedence.
range: "0..7"
"threshold-min-value": "integer", Minimum RED threshold value.
"threshold-max-units": "string", Maximum RED threshold units.
"dscp": "string", WRED based on DSCP.
"dei": "integer", DEI based WRED.\nShould be value 0..1.
range: "0..1"
"threshold-min-units": "string", Minimum RED threshold units.
"ecn": [ null ], ECN based WRED.
"discard-class": "string", WRED based on discard class.
range: "0..7"
"mpls-exp": "string" MPLS Experimental value based WRED.
range: "0..7"
}
}
SET - Update
Update operation of resource: set
setbody object
ID of type name
ID of class-name class-type
Request Content-Types: application/json
Request Example
{ "dei": "integer", Set DEI bit.
range: "0..1"
"cos": "integer", Sets the specific IEEE 802.1Q Layer 2 CoS value of an\noutgoing packet.\nThis command should be used by a router if a user wants\nto mark a packet that is being sent to a switch.\nSwitches can leverage Layer 2 header information,\nincluding a CoS value marking. Packets entering an\ninterface cannot be set with a CoS value.
range: "0..7"
"inner-cos": "integer", Set inner cos.
range: "0..7"
"forward-class": "integer", Sets the forward class.
range: "0..7"
"precedence": "string", Sets the precedence value in the IP header.
range: "0..7"
"srp-priority": "integer", Sets the spatial reuse protocol priority value of an\noutgoing packet.
range: "0..7"
"df": "integer", Set DF bit.
range: "0..1"
"fr-de": "integer", Set FrameRelay DE bit.
range: "0..1"
"dscp-tunnel": "string", Marks a packet by setting DSCP in the tunnel header.\nThis is specific to ipsec tunnels
"mpls-experimental-top-most": "integer", Sets the experimental value of the MPLS packet top-most\nlabels.
range: "0..7"
"dscp": "string", Marks a packet by setting the DSCP in the ToS byte.
"mpls-experimental-imposition": "integer", Sets the experimental value of the MPLS packet\nimposition labels.\nImposition can be used only in service policies that\nare attached in the ingress policy
range: "0..7"
"qos-group": "integer", Sets the QoS group identifiers on IPv4 or MPLS packets.\nThe set qos-group is supported only on an ingress policy.
range: "0..512"
"traffic-class": "integer", Sets the Traffic class identifiers on IPv4 or MPLS packets.
range: "0..63"
"destination-address": "string", Destination IPv4 address.
"precedence-tunnel": "string", Sets the precedence tunnel value for ipsec.
range: "0..7"
"source-address": "string", Source IPv4 address.
"discard-class": "integer", Sets the discard class on IPv4 or MPLS packets.\nThe discard-class can be used only in service policies\nthat are attached in the ingress policy.
range: "0..7"
"dei-imposition": "integer", Set DEI imposition bit.
range: "0..1"
"atm-clp": [ null ] Set atm cell-loss-priority bit.
}
}
Successful operation
Internal Error
Response Content-Types: application/json
SET - Create
Create operation of resource: set
setbody object
ID of type name
ID of class-name class-type
Request Content-Types: application/json
Request Example
{ "dei": "integer", Set DEI bit.
range: "0..1"
"cos": "integer", Sets the specific IEEE 802.1Q Layer 2 CoS value of an\noutgoing packet.\nThis command should be used by a router if a user wants\nto mark a packet that is being sent to a switch.\nSwitches can leverage Layer 2 header information,\nincluding a CoS value marking. Packets entering an\ninterface cannot be set with a CoS value.
range: "0..7"
"inner-cos": "integer", Set inner cos.
range: "0..7"
"forward-class": "integer", Sets the forward class.
range: "0..7"
"precedence": "string", Sets the precedence value in the IP header.
range: "0..7"
"srp-priority": "integer", Sets the spatial reuse protocol priority value of an\noutgoing packet.
range: "0..7"
"df": "integer", Set DF bit.
range: "0..1"
"fr-de": "integer", Set FrameRelay DE bit.
range: "0..1"
"dscp-tunnel": "string", Marks a packet by setting DSCP in the tunnel header.\nThis is specific to ipsec tunnels
"mpls-experimental-top-most": "integer", Sets the experimental value of the MPLS packet top-most\nlabels.
range: "0..7"
"dscp": "string", Marks a packet by setting the DSCP in the ToS byte.
"mpls-experimental-imposition": "integer", Sets the experimental value of the MPLS packet\nimposition labels.\nImposition can be used only in service policies that\nare attached in the ingress policy
range: "0..7"
"qos-group": "integer", Sets the QoS group identifiers on IPv4 or MPLS packets.\nThe set qos-group is supported only on an ingress policy.
range: "0..512"
"traffic-class": "integer", Sets the Traffic class identifiers on IPv4 or MPLS packets.
range: "0..63"
"destination-address": "string", Destination IPv4 address.
"precedence-tunnel": "string", Sets the precedence tunnel value for ipsec.
range: "0..7"
"source-address": "string", Source IPv4 address.
"discard-class": "integer", Sets the discard class on IPv4 or MPLS packets.\nThe discard-class can be used only in service policies\nthat are attached in the ingress policy.
range: "0..7"
"dei-imposition": "integer", Set DEI imposition bit.
range: "0..1"
"atm-clp": [ null ] Set atm cell-loss-priority bit.
}
}
Successful operation
Internal Error
Response Content-Types: application/json
SET - Delete
Delete operation of resource: set
ID of type name
ID of class-name class-type
Successful operation
Internal Error
Response Content-Types: application/json
SET - Retrieve
Retrieve operation of resource: set
ID of type name
ID of class-name class-type
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "dei": "integer", Set DEI bit.
range: "0..1"
"cos": "integer", Sets the specific IEEE 802.1Q Layer 2 CoS value of an\noutgoing packet.\nThis command should be used by a router if a user wants\nto mark a packet that is being sent to a switch.\nSwitches can leverage Layer 2 header information,\nincluding a CoS value marking. Packets entering an\ninterface cannot be set with a CoS value.
range: "0..7"
"inner-cos": "integer", Set inner cos.
range: "0..7"
"forward-class": "integer", Sets the forward class.
range: "0..7"
"precedence": "string", Sets the precedence value in the IP header.
range: "0..7"
"srp-priority": "integer", Sets the spatial reuse protocol priority value of an\noutgoing packet.
range: "0..7"
"df": "integer", Set DF bit.
range: "0..1"
"fr-de": "integer", Set FrameRelay DE bit.
range: "0..1"
"dscp-tunnel": "string", Marks a packet by setting DSCP in the tunnel header.\nThis is specific to ipsec tunnels
"mpls-experimental-top-most": "integer", Sets the experimental value of the MPLS packet top-most\nlabels.
range: "0..7"
"dscp": "string", Marks a packet by setting the DSCP in the ToS byte.
"mpls-experimental-imposition": "integer", Sets the experimental value of the MPLS packet\nimposition labels.\nImposition can be used only in service policies that\nare attached in the ingress policy
range: "0..7"
"qos-group": "integer", Sets the QoS group identifiers on IPv4 or MPLS packets.\nThe set qos-group is supported only on an ingress policy.
range: "0..512"
"traffic-class": "integer", Sets the Traffic class identifiers on IPv4 or MPLS packets.
range: "0..63"
"destination-address": "string", Destination IPv4 address.
"precedence-tunnel": "string", Sets the precedence tunnel value for ipsec.
range: "0..7"
"source-address": "string", Source IPv4 address.
"discard-class": "integer", Sets the discard class on IPv4 or MPLS packets.\nThe discard-class can be used only in service policies\nthat are attached in the ingress policy.
range: "0..7"
"dei-imposition": "integer", Set DEI imposition bit.
range: "0..1"
"atm-clp": [ null ] Set atm cell-loss-priority bit.
}
}
POLICE - Update
Update operation of resource: police
policebody object
ID of type name
ID of class-name class-type
Request Content-Types: application/json
Request Example
{ "Transmit": [ null ], Police action transmit.
"drop": [ null ], Police action drop. "dei": "integer", Set DEI bit.
range: "0..1"
"cos": "integer", Sets the specific IEEE 802.1Q Layer 2 CoS value of an\noutgoing packet.\nThis command should be used by a router if a user wants\nto mark a packet that is being sent to a switch.\nSwitches can leverage Layer 2 header information,\nincluding a CoS value marking. Packets entering an\ninterface cannot be set with a CoS value.
range: "0..7"
"inner-cos": "integer", Set inner cos.
range: "0..7"
"forward-class": "integer", Sets the forward class.
range: "0..7"
"precedence": "string", Sets the precedence value in the IP header.
range: "0..7"
"srp-priority": "integer", Sets the spatial reuse protocol priority value of an\noutgoing packet.
range: "0..7"
"df": "integer", Set DF bit.
range: "0..1"
"fr-de": "integer", Set FrameRelay DE bit.
range: "0..1"
"dscp-tunnel": "string", Marks a packet by setting DSCP in the tunnel header.\nThis is specific to ipsec tunnels
"mpls-experimental-top-most": "integer", Sets the experimental value of the MPLS packet top-most\nlabels.
range: "0..7"
"dscp": "string", Marks a packet by setting the DSCP in the ToS byte.
"mpls-experimental-imposition": "integer", Sets the experimental value of the MPLS packet\nimposition labels.\nImposition can be used only in service policies that\nare attached in the ingress policy
range: "0..7"
"qos-group": "integer", Sets the QoS group identifiers on IPv4 or MPLS packets.\nThe set qos-group is supported only on an ingress policy.
range: "0..512"
"traffic-class": "integer", Sets the Traffic class identifiers on IPv4 or MPLS packets.
range: "0..63"
"destination-address": "string", Destination IPv4 address.
"precedence-tunnel": "string", Sets the precedence tunnel value for ipsec.
range: "0..7"
"source-address": "string", Source IPv4 address.
"discard-class": "integer", Sets the discard class on IPv4 or MPLS packets.\nThe discard-class can be used only in service policies\nthat are attached in the ingress policy.
range: "0..7"
"dei-imposition": "integer", Set DEI imposition bit.
range: "0..1"
"atm-clp": [ null ] Set atm cell-loss-priority bit.
}
}, "units": "string", Burst units.
"value": "integer" Burst value.
}, "units": "string", Burst units.
"value": "integer" Burst value.
}, "units": "string", Burst units.
"value": "integer" Burst value.
}, "Transmit": [ null ], Police action transmit.
"drop": [ null ], Police action drop. "dei": "integer", Set DEI bit.
range: "0..1"
"cos": "integer", Sets the specific IEEE 802.1Q Layer 2 CoS value of an\noutgoing packet.\nThis command should be used by a router if a user wants\nto mark a packet that is being sent to a switch.\nSwitches can leverage Layer 2 header information,\nincluding a CoS value marking. Packets entering an\ninterface cannot be set with a CoS value.
range: "0..7"
"inner-cos": "integer", Set inner cos.
range: "0..7"
"forward-class": "integer", Sets the forward class.
range: "0..7"
"precedence": "string", Sets the precedence value in the IP header.
range: "0..7"
"srp-priority": "integer", Sets the spatial reuse protocol priority value of an\noutgoing packet.
range: "0..7"
"df": "integer", Set DF bit.
range: "0..1"
"fr-de": "integer", Set FrameRelay DE bit.
range: "0..1"
"dscp-tunnel": "string", Marks a packet by setting DSCP in the tunnel header.\nThis is specific to ipsec tunnels
"mpls-experimental-top-most": "integer", Sets the experimental value of the MPLS packet top-most\nlabels.
range: "0..7"
"dscp": "string", Marks a packet by setting the DSCP in the ToS byte.
"mpls-experimental-imposition": "integer", Sets the experimental value of the MPLS packet\nimposition labels.\nImposition can be used only in service policies that\nare attached in the ingress policy
range: "0..7"
"qos-group": "integer", Sets the QoS group identifiers on IPv4 or MPLS packets.\nThe set qos-group is supported only on an ingress policy.
range: "0..512"
"traffic-class": "integer", Sets the Traffic class identifiers on IPv4 or MPLS packets.
range: "0..63"
"destination-address": "string", Destination IPv4 address.
"precedence-tunnel": "string", Sets the precedence tunnel value for ipsec.
range: "0..7"
"source-address": "string", Source IPv4 address.
"discard-class": "integer", Sets the discard class on IPv4 or MPLS packets.\nThe discard-class can be used only in service policies\nthat are attached in the ingress policy.
range: "0..7"
"dei-imposition": "integer", Set DEI imposition bit.
range: "0..1"
"atm-clp": [ null ] Set atm cell-loss-priority bit.
}
}, "units": "string", Burst units.
"value": "integer" Burst value.
}, "Transmit": [ null ], Police action transmit.
"drop": [ null ], Police action drop. "dei": "integer", Set DEI bit.
range: "0..1"
"cos": "integer", Sets the specific IEEE 802.1Q Layer 2 CoS value of an\noutgoing packet.\nThis command should be used by a router if a user wants\nto mark a packet that is being sent to a switch.\nSwitches can leverage Layer 2 header information,\nincluding a CoS value marking. Packets entering an\ninterface cannot be set with a CoS value.
range: "0..7"
"inner-cos": "integer", Set inner cos.
range: "0..7"
"forward-class": "integer", Sets the forward class.
range: "0..7"
"precedence": "string", Sets the precedence value in the IP header.
range: "0..7"
"srp-priority": "integer", Sets the spatial reuse protocol priority value of an\noutgoing packet.
range: "0..7"
"df": "integer", Set DF bit.
range: "0..1"
"fr-de": "integer", Set FrameRelay DE bit.
range: "0..1"
"dscp-tunnel": "string", Marks a packet by setting DSCP in the tunnel header.\nThis is specific to ipsec tunnels
"mpls-experimental-top-most": "integer", Sets the experimental value of the MPLS packet top-most\nlabels.
range: "0..7"
"dscp": "string", Marks a packet by setting the DSCP in the ToS byte.
"mpls-experimental-imposition": "integer", Sets the experimental value of the MPLS packet\nimposition labels.\nImposition can be used only in service policies that\nare attached in the ingress policy
range: "0..7"
"qos-group": "integer", Sets the QoS group identifiers on IPv4 or MPLS packets.\nThe set qos-group is supported only on an ingress policy.
range: "0..512"
"traffic-class": "integer", Sets the Traffic class identifiers on IPv4 or MPLS packets.
range: "0..63"
"destination-address": "string", Destination IPv4 address.
"precedence-tunnel": "string", Sets the precedence tunnel value for ipsec.
range: "0..7"
"source-address": "string", Source IPv4 address.
"discard-class": "integer", Sets the discard class on IPv4 or MPLS packets.\nThe discard-class can be used only in service policies\nthat are attached in the ingress policy.
range: "0..7"
"dei-imposition": "integer", Set DEI imposition bit.
range: "0..1"
"atm-clp": [ null ] Set atm cell-loss-priority bit.
}
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
POLICE - Create
Create operation of resource: police
policebody object
ID of type name
ID of class-name class-type
Request Content-Types: application/json
Request Example
{ "Transmit": [ null ], Police action transmit.
"drop": [ null ], Police action drop. "dei": "integer", Set DEI bit.
range: "0..1"
"cos": "integer", Sets the specific IEEE 802.1Q Layer 2 CoS value of an\noutgoing packet.\nThis command should be used by a router if a user wants\nto mark a packet that is being sent to a switch.\nSwitches can leverage Layer 2 header information,\nincluding a CoS value marking. Packets entering an\ninterface cannot be set with a CoS value.
range: "0..7"
"inner-cos": "integer", Set inner cos.
range: "0..7"
"forward-class": "integer", Sets the forward class.
range: "0..7"
"precedence": "string", Sets the precedence value in the IP header.
range: "0..7"
"srp-priority": "integer", Sets the spatial reuse protocol priority value of an\noutgoing packet.
range: "0..7"
"df": "integer", Set DF bit.
range: "0..1"
"fr-de": "integer", Set FrameRelay DE bit.
range: "0..1"
"dscp-tunnel": "string", Marks a packet by setting DSCP in the tunnel header.\nThis is specific to ipsec tunnels
"mpls-experimental-top-most": "integer", Sets the experimental value of the MPLS packet top-most\nlabels.
range: "0..7"
"dscp": "string", Marks a packet by setting the DSCP in the ToS byte.
"mpls-experimental-imposition": "integer", Sets the experimental value of the MPLS packet\nimposition labels.\nImposition can be used only in service policies that\nare attached in the ingress policy
range: "0..7"
"qos-group": "integer", Sets the QoS group identifiers on IPv4 or MPLS packets.\nThe set qos-group is supported only on an ingress policy.
range: "0..512"
"traffic-class": "integer", Sets the Traffic class identifiers on IPv4 or MPLS packets.
range: "0..63"
"destination-address": "string", Destination IPv4 address.
"precedence-tunnel": "string", Sets the precedence tunnel value for ipsec.
range: "0..7"
"source-address": "string", Source IPv4 address.
"discard-class": "integer", Sets the discard class on IPv4 or MPLS packets.\nThe discard-class can be used only in service policies\nthat are attached in the ingress policy.
range: "0..7"
"dei-imposition": "integer", Set DEI imposition bit.
range: "0..1"
"atm-clp": [ null ] Set atm cell-loss-priority bit.
}
}, "units": "string", Burst units.
"value": "integer" Burst value.
}, "units": "string", Burst units.
"value": "integer" Burst value.
}, "units": "string", Burst units.
"value": "integer" Burst value.
}, "Transmit": [ null ], Police action transmit.
"drop": [ null ], Police action drop. "dei": "integer", Set DEI bit.
range: "0..1"
"cos": "integer", Sets the specific IEEE 802.1Q Layer 2 CoS value of an\noutgoing packet.\nThis command should be used by a router if a user wants\nto mark a packet that is being sent to a switch.\nSwitches can leverage Layer 2 header information,\nincluding a CoS value marking. Packets entering an\ninterface cannot be set with a CoS value.
range: "0..7"
"inner-cos": "integer", Set inner cos.
range: "0..7"
"forward-class": "integer", Sets the forward class.
range: "0..7"
"precedence": "string", Sets the precedence value in the IP header.
range: "0..7"
"srp-priority": "integer", Sets the spatial reuse protocol priority value of an\noutgoing packet.
range: "0..7"
"df": "integer", Set DF bit.
range: "0..1"
"fr-de": "integer", Set FrameRelay DE bit.
range: "0..1"
"dscp-tunnel": "string", Marks a packet by setting DSCP in the tunnel header.\nThis is specific to ipsec tunnels
"mpls-experimental-top-most": "integer", Sets the experimental value of the MPLS packet top-most\nlabels.
range: "0..7"
"dscp": "string", Marks a packet by setting the DSCP in the ToS byte.
"mpls-experimental-imposition": "integer", Sets the experimental value of the MPLS packet\nimposition labels.\nImposition can be used only in service policies that\nare attached in the ingress policy
range: "0..7"
"qos-group": "integer", Sets the QoS group identifiers on IPv4 or MPLS packets.\nThe set qos-group is supported only on an ingress policy.
range: "0..512"
"traffic-class": "integer", Sets the Traffic class identifiers on IPv4 or MPLS packets.
range: "0..63"
"destination-address": "string", Destination IPv4 address.
"precedence-tunnel": "string", Sets the precedence tunnel value for ipsec.
range: "0..7"
"source-address": "string", Source IPv4 address.
"discard-class": "integer", Sets the discard class on IPv4 or MPLS packets.\nThe discard-class can be used only in service policies\nthat are attached in the ingress policy.
range: "0..7"
"dei-imposition": "integer", Set DEI imposition bit.
range: "0..1"
"atm-clp": [ null ] Set atm cell-loss-priority bit.
}
}, "units": "string", Burst units.
"value": "integer" Burst value.
}, "Transmit": [ null ], Police action transmit.
"drop": [ null ], Police action drop. "dei": "integer", Set DEI bit.
range: "0..1"
"cos": "integer", Sets the specific IEEE 802.1Q Layer 2 CoS value of an\noutgoing packet.\nThis command should be used by a router if a user wants\nto mark a packet that is being sent to a switch.\nSwitches can leverage Layer 2 header information,\nincluding a CoS value marking. Packets entering an\ninterface cannot be set with a CoS value.
range: "0..7"
"inner-cos": "integer", Set inner cos.
range: "0..7"
"forward-class": "integer", Sets the forward class.
range: "0..7"
"precedence": "string", Sets the precedence value in the IP header.
range: "0..7"
"srp-priority": "integer", Sets the spatial reuse protocol priority value of an\noutgoing packet.
range: "0..7"
"df": "integer", Set DF bit.
range: "0..1"
"fr-de": "integer", Set FrameRelay DE bit.
range: "0..1"
"dscp-tunnel": "string", Marks a packet by setting DSCP in the tunnel header.\nThis is specific to ipsec tunnels
"mpls-experimental-top-most": "integer", Sets the experimental value of the MPLS packet top-most\nlabels.
range: "0..7"
"dscp": "string", Marks a packet by setting the DSCP in the ToS byte.
"mpls-experimental-imposition": "integer", Sets the experimental value of the MPLS packet\nimposition labels.\nImposition can be used only in service policies that\nare attached in the ingress policy
range: "0..7"
"qos-group": "integer", Sets the QoS group identifiers on IPv4 or MPLS packets.\nThe set qos-group is supported only on an ingress policy.
range: "0..512"
"traffic-class": "integer", Sets the Traffic class identifiers on IPv4 or MPLS packets.
range: "0..63"
"destination-address": "string", Destination IPv4 address.
"precedence-tunnel": "string", Sets the precedence tunnel value for ipsec.
range: "0..7"
"source-address": "string", Source IPv4 address.
"discard-class": "integer", Sets the discard class on IPv4 or MPLS packets.\nThe discard-class can be used only in service policies\nthat are attached in the ingress policy.
range: "0..7"
"dei-imposition": "integer", Set DEI imposition bit.
range: "0..1"
"atm-clp": [ null ] Set atm cell-loss-priority bit.
}
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
POLICE - Delete
Delete operation of resource: police
ID of type name
ID of class-name class-type
Successful operation
Internal Error
Response Content-Types: application/json
POLICE - Retrieve
Retrieve operation of resource: police
ID of type name
ID of class-name class-type
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "Transmit": [ null ], Police action transmit.
"drop": [ null ], Police action drop. "dei": "integer", Set DEI bit.
range: "0..1"
"cos": "integer", Sets the specific IEEE 802.1Q Layer 2 CoS value of an\noutgoing packet.\nThis command should be used by a router if a user wants\nto mark a packet that is being sent to a switch.\nSwitches can leverage Layer 2 header information,\nincluding a CoS value marking. Packets entering an\ninterface cannot be set with a CoS value.
range: "0..7"
"inner-cos": "integer", Set inner cos.
range: "0..7"
"forward-class": "integer", Sets the forward class.
range: "0..7"
"precedence": "string", Sets the precedence value in the IP header.
range: "0..7"
"srp-priority": "integer", Sets the spatial reuse protocol priority value of an\noutgoing packet.
range: "0..7"
"df": "integer", Set DF bit.
range: "0..1"
"fr-de": "integer", Set FrameRelay DE bit.
range: "0..1"
"dscp-tunnel": "string", Marks a packet by setting DSCP in the tunnel header.\nThis is specific to ipsec tunnels
"mpls-experimental-top-most": "integer", Sets the experimental value of the MPLS packet top-most\nlabels.
range: "0..7"
"dscp": "string", Marks a packet by setting the DSCP in the ToS byte.
"mpls-experimental-imposition": "integer", Sets the experimental value of the MPLS packet\nimposition labels.\nImposition can be used only in service policies that\nare attached in the ingress policy
range: "0..7"
"qos-group": "integer", Sets the QoS group identifiers on IPv4 or MPLS packets.\nThe set qos-group is supported only on an ingress policy.
range: "0..512"
"traffic-class": "integer", Sets the Traffic class identifiers on IPv4 or MPLS packets.
range: "0..63"
"destination-address": "string", Destination IPv4 address.
"precedence-tunnel": "string", Sets the precedence tunnel value for ipsec.
range: "0..7"
"source-address": "string", Source IPv4 address.
"discard-class": "integer", Sets the discard class on IPv4 or MPLS packets.\nThe discard-class can be used only in service policies\nthat are attached in the ingress policy.
range: "0..7"
"dei-imposition": "integer", Set DEI imposition bit.
range: "0..1"
"atm-clp": [ null ] Set atm cell-loss-priority bit.
}
}, "units": "string", Burst units.
"value": "integer" Burst value.
}, "units": "string", Burst units.
"value": "integer" Burst value.
}, "units": "string", Burst units.
"value": "integer" Burst value.
}, "Transmit": [ null ], Police action transmit.
"drop": [ null ], Police action drop. "dei": "integer", Set DEI bit.
range: "0..1"
"cos": "integer", Sets the specific IEEE 802.1Q Layer 2 CoS value of an\noutgoing packet.\nThis command should be used by a router if a user wants\nto mark a packet that is being sent to a switch.\nSwitches can leverage Layer 2 header information,\nincluding a CoS value marking. Packets entering an\ninterface cannot be set with a CoS value.
range: "0..7"
"inner-cos": "integer", Set inner cos.
range: "0..7"
"forward-class": "integer", Sets the forward class.
range: "0..7"
"precedence": "string", Sets the precedence value in the IP header.
range: "0..7"
"srp-priority": "integer", Sets the spatial reuse protocol priority value of an\noutgoing packet.
range: "0..7"
"df": "integer", Set DF bit.
range: "0..1"
"fr-de": "integer", Set FrameRelay DE bit.
range: "0..1"
"dscp-tunnel": "string", Marks a packet by setting DSCP in the tunnel header.\nThis is specific to ipsec tunnels
"mpls-experimental-top-most": "integer", Sets the experimental value of the MPLS packet top-most\nlabels.
range: "0..7"
"dscp": "string", Marks a packet by setting the DSCP in the ToS byte.
"mpls-experimental-imposition": "integer", Sets the experimental value of the MPLS packet\nimposition labels.\nImposition can be used only in service policies that\nare attached in the ingress policy
range: "0..7"
"qos-group": "integer", Sets the QoS group identifiers on IPv4 or MPLS packets.\nThe set qos-group is supported only on an ingress policy.
range: "0..512"
"traffic-class": "integer", Sets the Traffic class identifiers on IPv4 or MPLS packets.
range: "0..63"
"destination-address": "string", Destination IPv4 address.
"precedence-tunnel": "string", Sets the precedence tunnel value for ipsec.
range: "0..7"
"source-address": "string", Source IPv4 address.
"discard-class": "integer", Sets the discard class on IPv4 or MPLS packets.\nThe discard-class can be used only in service policies\nthat are attached in the ingress policy.
range: "0..7"
"dei-imposition": "integer", Set DEI imposition bit.
range: "0..1"
"atm-clp": [ null ] Set atm cell-loss-priority bit.
}
}, "units": "string", Burst units.
"value": "integer" Burst value.
}, "Transmit": [ null ], Police action transmit.
"drop": [ null ], Police action drop. "dei": "integer", Set DEI bit.
range: "0..1"
"cos": "integer", Sets the specific IEEE 802.1Q Layer 2 CoS value of an\noutgoing packet.\nThis command should be used by a router if a user wants\nto mark a packet that is being sent to a switch.\nSwitches can leverage Layer 2 header information,\nincluding a CoS value marking. Packets entering an\ninterface cannot be set with a CoS value.
range: "0..7"
"inner-cos": "integer", Set inner cos.
range: "0..7"
"forward-class": "integer", Sets the forward class.
range: "0..7"
"precedence": "string", Sets the precedence value in the IP header.
range: "0..7"
"srp-priority": "integer", Sets the spatial reuse protocol priority value of an\noutgoing packet.
range: "0..7"
"df": "integer", Set DF bit.
range: "0..1"
"fr-de": "integer", Set FrameRelay DE bit.
range: "0..1"
"dscp-tunnel": "string", Marks a packet by setting DSCP in the tunnel header.\nThis is specific to ipsec tunnels
"mpls-experimental-top-most": "integer", Sets the experimental value of the MPLS packet top-most\nlabels.
range: "0..7"
"dscp": "string", Marks a packet by setting the DSCP in the ToS byte.
"mpls-experimental-imposition": "integer", Sets the experimental value of the MPLS packet\nimposition labels.\nImposition can be used only in service policies that\nare attached in the ingress policy
range: "0..7"
"qos-group": "integer", Sets the QoS group identifiers on IPv4 or MPLS packets.\nThe set qos-group is supported only on an ingress policy.
range: "0..512"
"traffic-class": "integer", Sets the Traffic class identifiers on IPv4 or MPLS packets.
range: "0..63"
"destination-address": "string", Destination IPv4 address.
"precedence-tunnel": "string", Sets the precedence tunnel value for ipsec.
range: "0..7"
"source-address": "string", Source IPv4 address.
"discard-class": "integer", Sets the discard class on IPv4 or MPLS packets.\nThe discard-class can be used only in service policies\nthat are attached in the ingress policy.
range: "0..7"
"dei-imposition": "integer", Set DEI imposition bit.
range: "0..1"
"atm-clp": [ null ] Set atm cell-loss-priority bit.
}
}
}
}
RATE - Update
Update operation of resource: rate
ratebody object
ID of type name
ID of class-name class-type
Successful operation
Internal Error
Response Content-Types: application/json
RATE - Create
Create operation of resource: rate
ratebody object
ID of type name
ID of class-name class-type
Successful operation
Internal Error
Response Content-Types: application/json
RATE - Delete
Delete operation of resource: rate
ID of type name
ID of class-name class-type
Successful operation
Internal Error
Response Content-Types: application/json
RATE - Retrieve
Retrieve operation of resource: rate
ID of type name
ID of class-name class-type
Successful operation
Internal Error
PEAK-RATE - Update
Update operation of resource: peak-rate
peak-ratebody object
ID of type name
ID of class-name class-type
Successful operation
Internal Error
Response Content-Types: application/json
PEAK-RATE - Create
Create operation of resource: peak-rate
peak-ratebody object
ID of type name
ID of class-name class-type
Successful operation
Internal Error
Response Content-Types: application/json
PEAK-RATE - Delete
Delete operation of resource: peak-rate
ID of type name
ID of class-name class-type
Successful operation
Internal Error
Response Content-Types: application/json
PEAK-RATE - Retrieve
Retrieve operation of resource: peak-rate
ID of type name
ID of class-name class-type
Successful operation
Internal Error
BURST - Update
Update operation of resource: burst
burstbody object
ID of type name
ID of class-name class-type
Successful operation
Internal Error
Response Content-Types: application/json
BURST - Create
Create operation of resource: burst
burstbody object
ID of type name
ID of class-name class-type
Successful operation
Internal Error
Response Content-Types: application/json
BURST - Delete
Delete operation of resource: burst
ID of type name
ID of class-name class-type
Successful operation
Internal Error
Response Content-Types: application/json
BURST - Retrieve
Retrieve operation of resource: burst
ID of type name
ID of class-name class-type
Successful operation
Internal Error
PEAK-BURST - Update
Update operation of resource: peak-burst
peak-burstbody object
ID of type name
ID of class-name class-type
Successful operation
Internal Error
Response Content-Types: application/json
PEAK-BURST - Create
Create operation of resource: peak-burst
peak-burstbody object
ID of type name
ID of class-name class-type
Successful operation
Internal Error
Response Content-Types: application/json
PEAK-BURST - Delete
Delete operation of resource: peak-burst
ID of type name
ID of class-name class-type
Successful operation
Internal Error
Response Content-Types: application/json
PEAK-BURST - Retrieve
Retrieve operation of resource: peak-burst
ID of type name
ID of class-name class-type
Successful operation
Internal Error
CONFORM-ACTION - Update
Update operation of resource: conform-action
conform-actionbody object
ID of type name
ID of class-name class-type
Request Content-Types: application/json
Request Example
{ "Transmit": [ null ], Police action transmit.
"drop": [ null ], Police action drop. "dei": "integer", Set DEI bit.
range: "0..1"
"cos": "integer", Sets the specific IEEE 802.1Q Layer 2 CoS value of an\noutgoing packet.\nThis command should be used by a router if a user wants\nto mark a packet that is being sent to a switch.\nSwitches can leverage Layer 2 header information,\nincluding a CoS value marking. Packets entering an\ninterface cannot be set with a CoS value.
range: "0..7"
"inner-cos": "integer", Set inner cos.
range: "0..7"
"forward-class": "integer", Sets the forward class.
range: "0..7"
"precedence": "string", Sets the precedence value in the IP header.
range: "0..7"
"srp-priority": "integer", Sets the spatial reuse protocol priority value of an\noutgoing packet.
range: "0..7"
"df": "integer", Set DF bit.
range: "0..1"
"fr-de": "integer", Set FrameRelay DE bit.
range: "0..1"
"dscp-tunnel": "string", Marks a packet by setting DSCP in the tunnel header.\nThis is specific to ipsec tunnels
"mpls-experimental-top-most": "integer", Sets the experimental value of the MPLS packet top-most\nlabels.
range: "0..7"
"dscp": "string", Marks a packet by setting the DSCP in the ToS byte.
"mpls-experimental-imposition": "integer", Sets the experimental value of the MPLS packet\nimposition labels.\nImposition can be used only in service policies that\nare attached in the ingress policy
range: "0..7"
"qos-group": "integer", Sets the QoS group identifiers on IPv4 or MPLS packets.\nThe set qos-group is supported only on an ingress policy.
range: "0..512"
"traffic-class": "integer", Sets the Traffic class identifiers on IPv4 or MPLS packets.
range: "0..63"
"destination-address": "string", Destination IPv4 address.
"precedence-tunnel": "string", Sets the precedence tunnel value for ipsec.
range: "0..7"
"source-address": "string", Source IPv4 address.
"discard-class": "integer", Sets the discard class on IPv4 or MPLS packets.\nThe discard-class can be used only in service policies\nthat are attached in the ingress policy.
range: "0..7"
"dei-imposition": "integer", Set DEI imposition bit.
range: "0..1"
"atm-clp": [ null ] Set atm cell-loss-priority bit.
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
CONFORM-ACTION - Create
Create operation of resource: conform-action
conform-actionbody object
ID of type name
ID of class-name class-type
Request Content-Types: application/json
Request Example
{ "Transmit": [ null ], Police action transmit.
"drop": [ null ], Police action drop. "dei": "integer", Set DEI bit.
range: "0..1"
"cos": "integer", Sets the specific IEEE 802.1Q Layer 2 CoS value of an\noutgoing packet.\nThis command should be used by a router if a user wants\nto mark a packet that is being sent to a switch.\nSwitches can leverage Layer 2 header information,\nincluding a CoS value marking. Packets entering an\ninterface cannot be set with a CoS value.
range: "0..7"
"inner-cos": "integer", Set inner cos.
range: "0..7"
"forward-class": "integer", Sets the forward class.
range: "0..7"
"precedence": "string", Sets the precedence value in the IP header.
range: "0..7"
"srp-priority": "integer", Sets the spatial reuse protocol priority value of an\noutgoing packet.
range: "0..7"
"df": "integer", Set DF bit.
range: "0..1"
"fr-de": "integer", Set FrameRelay DE bit.
range: "0..1"
"dscp-tunnel": "string", Marks a packet by setting DSCP in the tunnel header.\nThis is specific to ipsec tunnels
"mpls-experimental-top-most": "integer", Sets the experimental value of the MPLS packet top-most\nlabels.
range: "0..7"
"dscp": "string", Marks a packet by setting the DSCP in the ToS byte.
"mpls-experimental-imposition": "integer", Sets the experimental value of the MPLS packet\nimposition labels.\nImposition can be used only in service policies that\nare attached in the ingress policy
range: "0..7"
"qos-group": "integer", Sets the QoS group identifiers on IPv4 or MPLS packets.\nThe set qos-group is supported only on an ingress policy.
range: "0..512"
"traffic-class": "integer", Sets the Traffic class identifiers on IPv4 or MPLS packets.
range: "0..63"
"destination-address": "string", Destination IPv4 address.
"precedence-tunnel": "string", Sets the precedence tunnel value for ipsec.
range: "0..7"
"source-address": "string", Source IPv4 address.
"discard-class": "integer", Sets the discard class on IPv4 or MPLS packets.\nThe discard-class can be used only in service policies\nthat are attached in the ingress policy.
range: "0..7"
"dei-imposition": "integer", Set DEI imposition bit.
range: "0..1"
"atm-clp": [ null ] Set atm cell-loss-priority bit.
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
CONFORM-ACTION - Delete
Delete operation of resource: conform-action
ID of type name
ID of class-name class-type
Successful operation
Internal Error
Response Content-Types: application/json
CONFORM-ACTION - Retrieve
Retrieve operation of resource: conform-action
ID of type name
ID of class-name class-type
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "Transmit": [ null ], Police action transmit.
"drop": [ null ], Police action drop. "dei": "integer", Set DEI bit.
range: "0..1"
"cos": "integer", Sets the specific IEEE 802.1Q Layer 2 CoS value of an\noutgoing packet.\nThis command should be used by a router if a user wants\nto mark a packet that is being sent to a switch.\nSwitches can leverage Layer 2 header information,\nincluding a CoS value marking. Packets entering an\ninterface cannot be set with a CoS value.
range: "0..7"
"inner-cos": "integer", Set inner cos.
range: "0..7"
"forward-class": "integer", Sets the forward class.
range: "0..7"
"precedence": "string", Sets the precedence value in the IP header.
range: "0..7"
"srp-priority": "integer", Sets the spatial reuse protocol priority value of an\noutgoing packet.
range: "0..7"
"df": "integer", Set DF bit.
range: "0..1"
"fr-de": "integer", Set FrameRelay DE bit.
range: "0..1"
"dscp-tunnel": "string", Marks a packet by setting DSCP in the tunnel header.\nThis is specific to ipsec tunnels
"mpls-experimental-top-most": "integer", Sets the experimental value of the MPLS packet top-most\nlabels.
range: "0..7"
"dscp": "string", Marks a packet by setting the DSCP in the ToS byte.
"mpls-experimental-imposition": "integer", Sets the experimental value of the MPLS packet\nimposition labels.\nImposition can be used only in service policies that\nare attached in the ingress policy
range: "0..7"
"qos-group": "integer", Sets the QoS group identifiers on IPv4 or MPLS packets.\nThe set qos-group is supported only on an ingress policy.
range: "0..512"
"traffic-class": "integer", Sets the Traffic class identifiers on IPv4 or MPLS packets.
range: "0..63"
"destination-address": "string", Destination IPv4 address.
"precedence-tunnel": "string", Sets the precedence tunnel value for ipsec.
range: "0..7"
"source-address": "string", Source IPv4 address.
"discard-class": "integer", Sets the discard class on IPv4 or MPLS packets.\nThe discard-class can be used only in service policies\nthat are attached in the ingress policy.
range: "0..7"
"dei-imposition": "integer", Set DEI imposition bit.
range: "0..1"
"atm-clp": [ null ] Set atm cell-loss-priority bit.
}
}
}
SET - Update
Update operation of resource: set
setbody object
ID of type name
ID of class-name class-type
Request Content-Types: application/json
Request Example
{ "dei": "integer", Set DEI bit.
range: "0..1"
"cos": "integer", Sets the specific IEEE 802.1Q Layer 2 CoS value of an\noutgoing packet.\nThis command should be used by a router if a user wants\nto mark a packet that is being sent to a switch.\nSwitches can leverage Layer 2 header information,\nincluding a CoS value marking. Packets entering an\ninterface cannot be set with a CoS value.
range: "0..7"
"inner-cos": "integer", Set inner cos.
range: "0..7"
"forward-class": "integer", Sets the forward class.
range: "0..7"
"precedence": "string", Sets the precedence value in the IP header.
range: "0..7"
"srp-priority": "integer", Sets the spatial reuse protocol priority value of an\noutgoing packet.
range: "0..7"
"df": "integer", Set DF bit.
range: "0..1"
"fr-de": "integer", Set FrameRelay DE bit.
range: "0..1"
"dscp-tunnel": "string", Marks a packet by setting DSCP in the tunnel header.\nThis is specific to ipsec tunnels
"mpls-experimental-top-most": "integer", Sets the experimental value of the MPLS packet top-most\nlabels.
range: "0..7"
"dscp": "string", Marks a packet by setting the DSCP in the ToS byte.
"mpls-experimental-imposition": "integer", Sets the experimental value of the MPLS packet\nimposition labels.\nImposition can be used only in service policies that\nare attached in the ingress policy
range: "0..7"
"qos-group": "integer", Sets the QoS group identifiers on IPv4 or MPLS packets.\nThe set qos-group is supported only on an ingress policy.
range: "0..512"
"traffic-class": "integer", Sets the Traffic class identifiers on IPv4 or MPLS packets.
range: "0..63"
"destination-address": "string", Destination IPv4 address.
"precedence-tunnel": "string", Sets the precedence tunnel value for ipsec.
range: "0..7"
"source-address": "string", Source IPv4 address.
"discard-class": "integer", Sets the discard class on IPv4 or MPLS packets.\nThe discard-class can be used only in service policies\nthat are attached in the ingress policy.
range: "0..7"
"dei-imposition": "integer", Set DEI imposition bit.
range: "0..1"
"atm-clp": [ null ] Set atm cell-loss-priority bit.
}
}
Successful operation
Internal Error
Response Content-Types: application/json
SET - Create
Create operation of resource: set
setbody object
ID of type name
ID of class-name class-type
Request Content-Types: application/json
Request Example
{ "dei": "integer", Set DEI bit.
range: "0..1"
"cos": "integer", Sets the specific IEEE 802.1Q Layer 2 CoS value of an\noutgoing packet.\nThis command should be used by a router if a user wants\nto mark a packet that is being sent to a switch.\nSwitches can leverage Layer 2 header information,\nincluding a CoS value marking. Packets entering an\ninterface cannot be set with a CoS value.
range: "0..7"
"inner-cos": "integer", Set inner cos.
range: "0..7"
"forward-class": "integer", Sets the forward class.
range: "0..7"
"precedence": "string", Sets the precedence value in the IP header.
range: "0..7"
"srp-priority": "integer", Sets the spatial reuse protocol priority value of an\noutgoing packet.
range: "0..7"
"df": "integer", Set DF bit.
range: "0..1"
"fr-de": "integer", Set FrameRelay DE bit.
range: "0..1"
"dscp-tunnel": "string", Marks a packet by setting DSCP in the tunnel header.\nThis is specific to ipsec tunnels
"mpls-experimental-top-most": "integer", Sets the experimental value of the MPLS packet top-most\nlabels.
range: "0..7"
"dscp": "string", Marks a packet by setting the DSCP in the ToS byte.
"mpls-experimental-imposition": "integer", Sets the experimental value of the MPLS packet\nimposition labels.\nImposition can be used only in service policies that\nare attached in the ingress policy
range: "0..7"
"qos-group": "integer", Sets the QoS group identifiers on IPv4 or MPLS packets.\nThe set qos-group is supported only on an ingress policy.
range: "0..512"
"traffic-class": "integer", Sets the Traffic class identifiers on IPv4 or MPLS packets.
range: "0..63"
"destination-address": "string", Destination IPv4 address.
"precedence-tunnel": "string", Sets the precedence tunnel value for ipsec.
range: "0..7"
"source-address": "string", Source IPv4 address.
"discard-class": "integer", Sets the discard class on IPv4 or MPLS packets.\nThe discard-class can be used only in service policies\nthat are attached in the ingress policy.
range: "0..7"
"dei-imposition": "integer", Set DEI imposition bit.
range: "0..1"
"atm-clp": [ null ] Set atm cell-loss-priority bit.
}
}
Successful operation
Internal Error
Response Content-Types: application/json
SET - Delete
Delete operation of resource: set
ID of type name
ID of class-name class-type
Successful operation
Internal Error
Response Content-Types: application/json
SET - Retrieve
Retrieve operation of resource: set
ID of type name
ID of class-name class-type
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "dei": "integer", Set DEI bit.
range: "0..1"
"cos": "integer", Sets the specific IEEE 802.1Q Layer 2 CoS value of an\noutgoing packet.\nThis command should be used by a router if a user wants\nto mark a packet that is being sent to a switch.\nSwitches can leverage Layer 2 header information,\nincluding a CoS value marking. Packets entering an\ninterface cannot be set with a CoS value.
range: "0..7"
"inner-cos": "integer", Set inner cos.
range: "0..7"
"forward-class": "integer", Sets the forward class.
range: "0..7"
"precedence": "string", Sets the precedence value in the IP header.
range: "0..7"
"srp-priority": "integer", Sets the spatial reuse protocol priority value of an\noutgoing packet.
range: "0..7"
"df": "integer", Set DF bit.
range: "0..1"
"fr-de": "integer", Set FrameRelay DE bit.
range: "0..1"
"dscp-tunnel": "string", Marks a packet by setting DSCP in the tunnel header.\nThis is specific to ipsec tunnels
"mpls-experimental-top-most": "integer", Sets the experimental value of the MPLS packet top-most\nlabels.
range: "0..7"
"dscp": "string", Marks a packet by setting the DSCP in the ToS byte.
"mpls-experimental-imposition": "integer", Sets the experimental value of the MPLS packet\nimposition labels.\nImposition can be used only in service policies that\nare attached in the ingress policy
range: "0..7"
"qos-group": "integer", Sets the QoS group identifiers on IPv4 or MPLS packets.\nThe set qos-group is supported only on an ingress policy.
range: "0..512"
"traffic-class": "integer", Sets the Traffic class identifiers on IPv4 or MPLS packets.
range: "0..63"
"destination-address": "string", Destination IPv4 address.
"precedence-tunnel": "string", Sets the precedence tunnel value for ipsec.
range: "0..7"
"source-address": "string", Source IPv4 address.
"discard-class": "integer", Sets the discard class on IPv4 or MPLS packets.\nThe discard-class can be used only in service policies\nthat are attached in the ingress policy.
range: "0..7"
"dei-imposition": "integer", Set DEI imposition bit.
range: "0..1"
"atm-clp": [ null ] Set atm cell-loss-priority bit.
}
}
EXCEED-ACTION - Update
Update operation of resource: exceed-action
exceed-actionbody object
ID of type name
ID of class-name class-type
Request Content-Types: application/json
Request Example
{ "Transmit": [ null ], Police action transmit.
"drop": [ null ], Police action drop. "dei": "integer", Set DEI bit.
range: "0..1"
"cos": "integer", Sets the specific IEEE 802.1Q Layer 2 CoS value of an\noutgoing packet.\nThis command should be used by a router if a user wants\nto mark a packet that is being sent to a switch.\nSwitches can leverage Layer 2 header information,\nincluding a CoS value marking. Packets entering an\ninterface cannot be set with a CoS value.
range: "0..7"
"inner-cos": "integer", Set inner cos.
range: "0..7"
"forward-class": "integer", Sets the forward class.
range: "0..7"
"precedence": "string", Sets the precedence value in the IP header.
range: "0..7"
"srp-priority": "integer", Sets the spatial reuse protocol priority value of an\noutgoing packet.
range: "0..7"
"df": "integer", Set DF bit.
range: "0..1"
"fr-de": "integer", Set FrameRelay DE bit.
range: "0..1"
"dscp-tunnel": "string", Marks a packet by setting DSCP in the tunnel header.\nThis is specific to ipsec tunnels
"mpls-experimental-top-most": "integer", Sets the experimental value of the MPLS packet top-most\nlabels.
range: "0..7"
"dscp": "string", Marks a packet by setting the DSCP in the ToS byte.
"mpls-experimental-imposition": "integer", Sets the experimental value of the MPLS packet\nimposition labels.\nImposition can be used only in service policies that\nare attached in the ingress policy
range: "0..7"
"qos-group": "integer", Sets the QoS group identifiers on IPv4 or MPLS packets.\nThe set qos-group is supported only on an ingress policy.
range: "0..512"
"traffic-class": "integer", Sets the Traffic class identifiers on IPv4 or MPLS packets.
range: "0..63"
"destination-address": "string", Destination IPv4 address.
"precedence-tunnel": "string", Sets the precedence tunnel value for ipsec.
range: "0..7"
"source-address": "string", Source IPv4 address.
"discard-class": "integer", Sets the discard class on IPv4 or MPLS packets.\nThe discard-class can be used only in service policies\nthat are attached in the ingress policy.
range: "0..7"
"dei-imposition": "integer", Set DEI imposition bit.
range: "0..1"
"atm-clp": [ null ] Set atm cell-loss-priority bit.
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
EXCEED-ACTION - Create
Create operation of resource: exceed-action
exceed-actionbody object
ID of type name
ID of class-name class-type
Request Content-Types: application/json
Request Example
{ "Transmit": [ null ], Police action transmit.
"drop": [ null ], Police action drop. "dei": "integer", Set DEI bit.
range: "0..1"
"cos": "integer", Sets the specific IEEE 802.1Q Layer 2 CoS value of an\noutgoing packet.\nThis command should be used by a router if a user wants\nto mark a packet that is being sent to a switch.\nSwitches can leverage Layer 2 header information,\nincluding a CoS value marking. Packets entering an\ninterface cannot be set with a CoS value.
range: "0..7"
"inner-cos": "integer", Set inner cos.
range: "0..7"
"forward-class": "integer", Sets the forward class.
range: "0..7"
"precedence": "string", Sets the precedence value in the IP header.
range: "0..7"
"srp-priority": "integer", Sets the spatial reuse protocol priority value of an\noutgoing packet.
range: "0..7"
"df": "integer", Set DF bit.
range: "0..1"
"fr-de": "integer", Set FrameRelay DE bit.
range: "0..1"
"dscp-tunnel": "string", Marks a packet by setting DSCP in the tunnel header.\nThis is specific to ipsec tunnels
"mpls-experimental-top-most": "integer", Sets the experimental value of the MPLS packet top-most\nlabels.
range: "0..7"
"dscp": "string", Marks a packet by setting the DSCP in the ToS byte.
"mpls-experimental-imposition": "integer", Sets the experimental value of the MPLS packet\nimposition labels.\nImposition can be used only in service policies that\nare attached in the ingress policy
range: "0..7"
"qos-group": "integer", Sets the QoS group identifiers on IPv4 or MPLS packets.\nThe set qos-group is supported only on an ingress policy.
range: "0..512"
"traffic-class": "integer", Sets the Traffic class identifiers on IPv4 or MPLS packets.
range: "0..63"
"destination-address": "string", Destination IPv4 address.
"precedence-tunnel": "string", Sets the precedence tunnel value for ipsec.
range: "0..7"
"source-address": "string", Source IPv4 address.
"discard-class": "integer", Sets the discard class on IPv4 or MPLS packets.\nThe discard-class can be used only in service policies\nthat are attached in the ingress policy.
range: "0..7"
"dei-imposition": "integer", Set DEI imposition bit.
range: "0..1"
"atm-clp": [ null ] Set atm cell-loss-priority bit.
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
EXCEED-ACTION - Delete
Delete operation of resource: exceed-action
ID of type name
ID of class-name class-type
Successful operation
Internal Error
Response Content-Types: application/json
EXCEED-ACTION - Retrieve
Retrieve operation of resource: exceed-action
ID of type name
ID of class-name class-type
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "Transmit": [ null ], Police action transmit.
"drop": [ null ], Police action drop. "dei": "integer", Set DEI bit.
range: "0..1"
"cos": "integer", Sets the specific IEEE 802.1Q Layer 2 CoS value of an\noutgoing packet.\nThis command should be used by a router if a user wants\nto mark a packet that is being sent to a switch.\nSwitches can leverage Layer 2 header information,\nincluding a CoS value marking. Packets entering an\ninterface cannot be set with a CoS value.
range: "0..7"
"inner-cos": "integer", Set inner cos.
range: "0..7"
"forward-class": "integer", Sets the forward class.
range: "0..7"
"precedence": "string", Sets the precedence value in the IP header.
range: "0..7"
"srp-priority": "integer", Sets the spatial reuse protocol priority value of an\noutgoing packet.
range: "0..7"
"df": "integer", Set DF bit.
range: "0..1"
"fr-de": "integer", Set FrameRelay DE bit.
range: "0..1"
"dscp-tunnel": "string", Marks a packet by setting DSCP in the tunnel header.\nThis is specific to ipsec tunnels
"mpls-experimental-top-most": "integer", Sets the experimental value of the MPLS packet top-most\nlabels.
range: "0..7"
"dscp": "string", Marks a packet by setting the DSCP in the ToS byte.
"mpls-experimental-imposition": "integer", Sets the experimental value of the MPLS packet\nimposition labels.\nImposition can be used only in service policies that\nare attached in the ingress policy
range: "0..7"
"qos-group": "integer", Sets the QoS group identifiers on IPv4 or MPLS packets.\nThe set qos-group is supported only on an ingress policy.
range: "0..512"
"traffic-class": "integer", Sets the Traffic class identifiers on IPv4 or MPLS packets.
range: "0..63"
"destination-address": "string", Destination IPv4 address.
"precedence-tunnel": "string", Sets the precedence tunnel value for ipsec.
range: "0..7"
"source-address": "string", Source IPv4 address.
"discard-class": "integer", Sets the discard class on IPv4 or MPLS packets.\nThe discard-class can be used only in service policies\nthat are attached in the ingress policy.
range: "0..7"
"dei-imposition": "integer", Set DEI imposition bit.
range: "0..1"
"atm-clp": [ null ] Set atm cell-loss-priority bit.
}
}
}
SET - Update
Update operation of resource: set
setbody object
ID of type name
ID of class-name class-type
Request Content-Types: application/json
Request Example
{ "dei": "integer", Set DEI bit.
range: "0..1"
"cos": "integer", Sets the specific IEEE 802.1Q Layer 2 CoS value of an\noutgoing packet.\nThis command should be used by a router if a user wants\nto mark a packet that is being sent to a switch.\nSwitches can leverage Layer 2 header information,\nincluding a CoS value marking. Packets entering an\ninterface cannot be set with a CoS value.
range: "0..7"
"inner-cos": "integer", Set inner cos.
range: "0..7"
"forward-class": "integer", Sets the forward class.
range: "0..7"
"precedence": "string", Sets the precedence value in the IP header.
range: "0..7"
"srp-priority": "integer", Sets the spatial reuse protocol priority value of an\noutgoing packet.
range: "0..7"
"df": "integer", Set DF bit.
range: "0..1"
"fr-de": "integer", Set FrameRelay DE bit.
range: "0..1"
"dscp-tunnel": "string", Marks a packet by setting DSCP in the tunnel header.\nThis is specific to ipsec tunnels
"mpls-experimental-top-most": "integer", Sets the experimental value of the MPLS packet top-most\nlabels.
range: "0..7"
"dscp": "string", Marks a packet by setting the DSCP in the ToS byte.
"mpls-experimental-imposition": "integer", Sets the experimental value of the MPLS packet\nimposition labels.\nImposition can be used only in service policies that\nare attached in the ingress policy
range: "0..7"
"qos-group": "integer", Sets the QoS group identifiers on IPv4 or MPLS packets.\nThe set qos-group is supported only on an ingress policy.
range: "0..512"
"traffic-class": "integer", Sets the Traffic class identifiers on IPv4 or MPLS packets.
range: "0..63"
"destination-address": "string", Destination IPv4 address.
"precedence-tunnel": "string", Sets the precedence tunnel value for ipsec.
range: "0..7"
"source-address": "string", Source IPv4 address.
"discard-class": "integer", Sets the discard class on IPv4 or MPLS packets.\nThe discard-class can be used only in service policies\nthat are attached in the ingress policy.
range: "0..7"
"dei-imposition": "integer", Set DEI imposition bit.
range: "0..1"
"atm-clp": [ null ] Set atm cell-loss-priority bit.
}
}
Successful operation
Internal Error
Response Content-Types: application/json
SET - Create
Create operation of resource: set
setbody object
ID of type name
ID of class-name class-type
Request Content-Types: application/json
Request Example
{ "dei": "integer", Set DEI bit.
range: "0..1"
"cos": "integer", Sets the specific IEEE 802.1Q Layer 2 CoS value of an\noutgoing packet.\nThis command should be used by a router if a user wants\nto mark a packet that is being sent to a switch.\nSwitches can leverage Layer 2 header information,\nincluding a CoS value marking. Packets entering an\ninterface cannot be set with a CoS value.
range: "0..7"
"inner-cos": "integer", Set inner cos.
range: "0..7"
"forward-class": "integer", Sets the forward class.
range: "0..7"
"precedence": "string", Sets the precedence value in the IP header.
range: "0..7"
"srp-priority": "integer", Sets the spatial reuse protocol priority value of an\noutgoing packet.
range: "0..7"
"df": "integer", Set DF bit.
range: "0..1"
"fr-de": "integer", Set FrameRelay DE bit.
range: "0..1"
"dscp-tunnel": "string", Marks a packet by setting DSCP in the tunnel header.\nThis is specific to ipsec tunnels
"mpls-experimental-top-most": "integer", Sets the experimental value of the MPLS packet top-most\nlabels.
range: "0..7"
"dscp": "string", Marks a packet by setting the DSCP in the ToS byte.
"mpls-experimental-imposition": "integer", Sets the experimental value of the MPLS packet\nimposition labels.\nImposition can be used only in service policies that\nare attached in the ingress policy
range: "0..7"
"qos-group": "integer", Sets the QoS group identifiers on IPv4 or MPLS packets.\nThe set qos-group is supported only on an ingress policy.
range: "0..512"
"traffic-class": "integer", Sets the Traffic class identifiers on IPv4 or MPLS packets.
range: "0..63"
"destination-address": "string", Destination IPv4 address.
"precedence-tunnel": "string", Sets the precedence tunnel value for ipsec.
range: "0..7"
"source-address": "string", Source IPv4 address.
"discard-class": "integer", Sets the discard class on IPv4 or MPLS packets.\nThe discard-class can be used only in service policies\nthat are attached in the ingress policy.
range: "0..7"
"dei-imposition": "integer", Set DEI imposition bit.
range: "0..1"
"atm-clp": [ null ] Set atm cell-loss-priority bit.
}
}
Successful operation
Internal Error
Response Content-Types: application/json
SET - Delete
Delete operation of resource: set
ID of type name
ID of class-name class-type
Successful operation
Internal Error
Response Content-Types: application/json
SET - Retrieve
Retrieve operation of resource: set
ID of type name
ID of class-name class-type
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "dei": "integer", Set DEI bit.
range: "0..1"
"cos": "integer", Sets the specific IEEE 802.1Q Layer 2 CoS value of an\noutgoing packet.\nThis command should be used by a router if a user wants\nto mark a packet that is being sent to a switch.\nSwitches can leverage Layer 2 header information,\nincluding a CoS value marking. Packets entering an\ninterface cannot be set with a CoS value.
range: "0..7"
"inner-cos": "integer", Set inner cos.
range: "0..7"
"forward-class": "integer", Sets the forward class.
range: "0..7"
"precedence": "string", Sets the precedence value in the IP header.
range: "0..7"
"srp-priority": "integer", Sets the spatial reuse protocol priority value of an\noutgoing packet.
range: "0..7"
"df": "integer", Set DF bit.
range: "0..1"
"fr-de": "integer", Set FrameRelay DE bit.
range: "0..1"
"dscp-tunnel": "string", Marks a packet by setting DSCP in the tunnel header.\nThis is specific to ipsec tunnels
"mpls-experimental-top-most": "integer", Sets the experimental value of the MPLS packet top-most\nlabels.
range: "0..7"
"dscp": "string", Marks a packet by setting the DSCP in the ToS byte.
"mpls-experimental-imposition": "integer", Sets the experimental value of the MPLS packet\nimposition labels.\nImposition can be used only in service policies that\nare attached in the ingress policy
range: "0..7"
"qos-group": "integer", Sets the QoS group identifiers on IPv4 or MPLS packets.\nThe set qos-group is supported only on an ingress policy.
range: "0..512"
"traffic-class": "integer", Sets the Traffic class identifiers on IPv4 or MPLS packets.
range: "0..63"
"destination-address": "string", Destination IPv4 address.
"precedence-tunnel": "string", Sets the precedence tunnel value for ipsec.
range: "0..7"
"source-address": "string", Source IPv4 address.
"discard-class": "integer", Sets the discard class on IPv4 or MPLS packets.\nThe discard-class can be used only in service policies\nthat are attached in the ingress policy.
range: "0..7"
"dei-imposition": "integer", Set DEI imposition bit.
range: "0..1"
"atm-clp": [ null ] Set atm cell-loss-priority bit.
}
}
VIOLATE-ACTION - Update
Update operation of resource: violate-action
violate-actionbody object
ID of type name
ID of class-name class-type
Request Content-Types: application/json
Request Example
{ "Transmit": [ null ], Police action transmit.
"drop": [ null ], Police action drop. "dei": "integer", Set DEI bit.
range: "0..1"
"cos": "integer", Sets the specific IEEE 802.1Q Layer 2 CoS value of an\noutgoing packet.\nThis command should be used by a router if a user wants\nto mark a packet that is being sent to a switch.\nSwitches can leverage Layer 2 header information,\nincluding a CoS value marking. Packets entering an\ninterface cannot be set with a CoS value.
range: "0..7"
"inner-cos": "integer", Set inner cos.
range: "0..7"
"forward-class": "integer", Sets the forward class.
range: "0..7"
"precedence": "string", Sets the precedence value in the IP header.
range: "0..7"
"srp-priority": "integer", Sets the spatial reuse protocol priority value of an\noutgoing packet.
range: "0..7"
"df": "integer", Set DF bit.
range: "0..1"
"fr-de": "integer", Set FrameRelay DE bit.
range: "0..1"
"dscp-tunnel": "string", Marks a packet by setting DSCP in the tunnel header.\nThis is specific to ipsec tunnels
"mpls-experimental-top-most": "integer", Sets the experimental value of the MPLS packet top-most\nlabels.
range: "0..7"
"dscp": "string", Marks a packet by setting the DSCP in the ToS byte.
"mpls-experimental-imposition": "integer", Sets the experimental value of the MPLS packet\nimposition labels.\nImposition can be used only in service policies that\nare attached in the ingress policy
range: "0..7"
"qos-group": "integer", Sets the QoS group identifiers on IPv4 or MPLS packets.\nThe set qos-group is supported only on an ingress policy.
range: "0..512"
"traffic-class": "integer", Sets the Traffic class identifiers on IPv4 or MPLS packets.
range: "0..63"
"destination-address": "string", Destination IPv4 address.
"precedence-tunnel": "string", Sets the precedence tunnel value for ipsec.
range: "0..7"
"source-address": "string", Source IPv4 address.
"discard-class": "integer", Sets the discard class on IPv4 or MPLS packets.\nThe discard-class can be used only in service policies\nthat are attached in the ingress policy.
range: "0..7"
"dei-imposition": "integer", Set DEI imposition bit.
range: "0..1"
"atm-clp": [ null ] Set atm cell-loss-priority bit.
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
VIOLATE-ACTION - Create
Create operation of resource: violate-action
violate-actionbody object
ID of type name
ID of class-name class-type
Request Content-Types: application/json
Request Example
{ "Transmit": [ null ], Police action transmit.
"drop": [ null ], Police action drop. "dei": "integer", Set DEI bit.
range: "0..1"
"cos": "integer", Sets the specific IEEE 802.1Q Layer 2 CoS value of an\noutgoing packet.\nThis command should be used by a router if a user wants\nto mark a packet that is being sent to a switch.\nSwitches can leverage Layer 2 header information,\nincluding a CoS value marking. Packets entering an\ninterface cannot be set with a CoS value.
range: "0..7"
"inner-cos": "integer", Set inner cos.
range: "0..7"
"forward-class": "integer", Sets the forward class.
range: "0..7"
"precedence": "string", Sets the precedence value in the IP header.
range: "0..7"
"srp-priority": "integer", Sets the spatial reuse protocol priority value of an\noutgoing packet.
range: "0..7"
"df": "integer", Set DF bit.
range: "0..1"
"fr-de": "integer", Set FrameRelay DE bit.
range: "0..1"
"dscp-tunnel": "string", Marks a packet by setting DSCP in the tunnel header.\nThis is specific to ipsec tunnels
"mpls-experimental-top-most": "integer", Sets the experimental value of the MPLS packet top-most\nlabels.
range: "0..7"
"dscp": "string", Marks a packet by setting the DSCP in the ToS byte.
"mpls-experimental-imposition": "integer", Sets the experimental value of the MPLS packet\nimposition labels.\nImposition can be used only in service policies that\nare attached in the ingress policy
range: "0..7"
"qos-group": "integer", Sets the QoS group identifiers on IPv4 or MPLS packets.\nThe set qos-group is supported only on an ingress policy.
range: "0..512"
"traffic-class": "integer", Sets the Traffic class identifiers on IPv4 or MPLS packets.
range: "0..63"
"destination-address": "string", Destination IPv4 address.
"precedence-tunnel": "string", Sets the precedence tunnel value for ipsec.
range: "0..7"
"source-address": "string", Source IPv4 address.
"discard-class": "integer", Sets the discard class on IPv4 or MPLS packets.\nThe discard-class can be used only in service policies\nthat are attached in the ingress policy.
range: "0..7"
"dei-imposition": "integer", Set DEI imposition bit.
range: "0..1"
"atm-clp": [ null ] Set atm cell-loss-priority bit.
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
VIOLATE-ACTION - Delete
Delete operation of resource: violate-action
ID of type name
ID of class-name class-type
Successful operation
Internal Error
Response Content-Types: application/json
VIOLATE-ACTION - Retrieve
Retrieve operation of resource: violate-action
ID of type name
ID of class-name class-type
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "Transmit": [ null ], Police action transmit.
"drop": [ null ], Police action drop. "dei": "integer", Set DEI bit.
range: "0..1"
"cos": "integer", Sets the specific IEEE 802.1Q Layer 2 CoS value of an\noutgoing packet.\nThis command should be used by a router if a user wants\nto mark a packet that is being sent to a switch.\nSwitches can leverage Layer 2 header information,\nincluding a CoS value marking. Packets entering an\ninterface cannot be set with a CoS value.
range: "0..7"
"inner-cos": "integer", Set inner cos.
range: "0..7"
"forward-class": "integer", Sets the forward class.
range: "0..7"
"precedence": "string", Sets the precedence value in the IP header.
range: "0..7"
"srp-priority": "integer", Sets the spatial reuse protocol priority value of an\noutgoing packet.
range: "0..7"
"df": "integer", Set DF bit.
range: "0..1"
"fr-de": "integer", Set FrameRelay DE bit.
range: "0..1"
"dscp-tunnel": "string", Marks a packet by setting DSCP in the tunnel header.\nThis is specific to ipsec tunnels
"mpls-experimental-top-most": "integer", Sets the experimental value of the MPLS packet top-most\nlabels.
range: "0..7"
"dscp": "string", Marks a packet by setting the DSCP in the ToS byte.
"mpls-experimental-imposition": "integer", Sets the experimental value of the MPLS packet\nimposition labels.\nImposition can be used only in service policies that\nare attached in the ingress policy
range: "0..7"
"qos-group": "integer", Sets the QoS group identifiers on IPv4 or MPLS packets.\nThe set qos-group is supported only on an ingress policy.
range: "0..512"
"traffic-class": "integer", Sets the Traffic class identifiers on IPv4 or MPLS packets.
range: "0..63"
"destination-address": "string", Destination IPv4 address.
"precedence-tunnel": "string", Sets the precedence tunnel value for ipsec.
range: "0..7"
"source-address": "string", Source IPv4 address.
"discard-class": "integer", Sets the discard class on IPv4 or MPLS packets.\nThe discard-class can be used only in service policies\nthat are attached in the ingress policy.
range: "0..7"
"dei-imposition": "integer", Set DEI imposition bit.
range: "0..1"
"atm-clp": [ null ] Set atm cell-loss-priority bit.
}
}
}
SET - Update
Update operation of resource: set
setbody object
ID of type name
ID of class-name class-type
Request Content-Types: application/json
Request Example
{ "dei": "integer", Set DEI bit.
range: "0..1"
"cos": "integer", Sets the specific IEEE 802.1Q Layer 2 CoS value of an\noutgoing packet.\nThis command should be used by a router if a user wants\nto mark a packet that is being sent to a switch.\nSwitches can leverage Layer 2 header information,\nincluding a CoS value marking. Packets entering an\ninterface cannot be set with a CoS value.
range: "0..7"
"inner-cos": "integer", Set inner cos.
range: "0..7"
"forward-class": "integer", Sets the forward class.
range: "0..7"
"precedence": "string", Sets the precedence value in the IP header.
range: "0..7"
"srp-priority": "integer", Sets the spatial reuse protocol priority value of an\noutgoing packet.
range: "0..7"
"df": "integer", Set DF bit.
range: "0..1"
"fr-de": "integer", Set FrameRelay DE bit.
range: "0..1"
"dscp-tunnel": "string", Marks a packet by setting DSCP in the tunnel header.\nThis is specific to ipsec tunnels
"mpls-experimental-top-most": "integer", Sets the experimental value of the MPLS packet top-most\nlabels.
range: "0..7"
"dscp": "string", Marks a packet by setting the DSCP in the ToS byte.
"mpls-experimental-imposition": "integer", Sets the experimental value of the MPLS packet\nimposition labels.\nImposition can be used only in service policies that\nare attached in the ingress policy
range: "0..7"
"qos-group": "integer", Sets the QoS group identifiers on IPv4 or MPLS packets.\nThe set qos-group is supported only on an ingress policy.
range: "0..512"
"traffic-class": "integer", Sets the Traffic class identifiers on IPv4 or MPLS packets.
range: "0..63"
"destination-address": "string", Destination IPv4 address.
"precedence-tunnel": "string", Sets the precedence tunnel value for ipsec.
range: "0..7"
"source-address": "string", Source IPv4 address.
"discard-class": "integer", Sets the discard class on IPv4 or MPLS packets.\nThe discard-class can be used only in service policies\nthat are attached in the ingress policy.
range: "0..7"
"dei-imposition": "integer", Set DEI imposition bit.
range: "0..1"
"atm-clp": [ null ] Set atm cell-loss-priority bit.
}
}
Successful operation
Internal Error
Response Content-Types: application/json
SET - Create
Create operation of resource: set
setbody object
ID of type name
ID of class-name class-type
Request Content-Types: application/json
Request Example
{ "dei": "integer", Set DEI bit.
range: "0..1"
"cos": "integer", Sets the specific IEEE 802.1Q Layer 2 CoS value of an\noutgoing packet.\nThis command should be used by a router if a user wants\nto mark a packet that is being sent to a switch.\nSwitches can leverage Layer 2 header information,\nincluding a CoS value marking. Packets entering an\ninterface cannot be set with a CoS value.
range: "0..7"
"inner-cos": "integer", Set inner cos.
range: "0..7"
"forward-class": "integer", Sets the forward class.
range: "0..7"
"precedence": "string", Sets the precedence value in the IP header.
range: "0..7"
"srp-priority": "integer", Sets the spatial reuse protocol priority value of an\noutgoing packet.
range: "0..7"
"df": "integer", Set DF bit.
range: "0..1"
"fr-de": "integer", Set FrameRelay DE bit.
range: "0..1"
"dscp-tunnel": "string", Marks a packet by setting DSCP in the tunnel header.\nThis is specific to ipsec tunnels
"mpls-experimental-top-most": "integer", Sets the experimental value of the MPLS packet top-most\nlabels.
range: "0..7"
"dscp": "string", Marks a packet by setting the DSCP in the ToS byte.
"mpls-experimental-imposition": "integer", Sets the experimental value of the MPLS packet\nimposition labels.\nImposition can be used only in service policies that\nare attached in the ingress policy
range: "0..7"
"qos-group": "integer", Sets the QoS group identifiers on IPv4 or MPLS packets.\nThe set qos-group is supported only on an ingress policy.
range: "0..512"
"traffic-class": "integer", Sets the Traffic class identifiers on IPv4 or MPLS packets.
range: "0..63"
"destination-address": "string", Destination IPv4 address.
"precedence-tunnel": "string", Sets the precedence tunnel value for ipsec.
range: "0..7"
"source-address": "string", Source IPv4 address.
"discard-class": "integer", Sets the discard class on IPv4 or MPLS packets.\nThe discard-class can be used only in service policies\nthat are attached in the ingress policy.
range: "0..7"
"dei-imposition": "integer", Set DEI imposition bit.
range: "0..1"
"atm-clp": [ null ] Set atm cell-loss-priority bit.
}
}
Successful operation
Internal Error
Response Content-Types: application/json
SET - Delete
Delete operation of resource: set
ID of type name
ID of class-name class-type
Successful operation
Internal Error
Response Content-Types: application/json
SET - Retrieve
Retrieve operation of resource: set
ID of type name
ID of class-name class-type
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "dei": "integer", Set DEI bit.
range: "0..1"
"cos": "integer", Sets the specific IEEE 802.1Q Layer 2 CoS value of an\noutgoing packet.\nThis command should be used by a router if a user wants\nto mark a packet that is being sent to a switch.\nSwitches can leverage Layer 2 header information,\nincluding a CoS value marking. Packets entering an\ninterface cannot be set with a CoS value.
range: "0..7"
"inner-cos": "integer", Set inner cos.
range: "0..7"
"forward-class": "integer", Sets the forward class.
range: "0..7"
"precedence": "string", Sets the precedence value in the IP header.
range: "0..7"
"srp-priority": "integer", Sets the spatial reuse protocol priority value of an\noutgoing packet.
range: "0..7"
"df": "integer", Set DF bit.
range: "0..1"
"fr-de": "integer", Set FrameRelay DE bit.
range: "0..1"
"dscp-tunnel": "string", Marks a packet by setting DSCP in the tunnel header.\nThis is specific to ipsec tunnels
"mpls-experimental-top-most": "integer", Sets the experimental value of the MPLS packet top-most\nlabels.
range: "0..7"
"dscp": "string", Marks a packet by setting the DSCP in the ToS byte.
"mpls-experimental-imposition": "integer", Sets the experimental value of the MPLS packet\nimposition labels.\nImposition can be used only in service policies that\nare attached in the ingress policy
range: "0..7"
"qos-group": "integer", Sets the QoS group identifiers on IPv4 or MPLS packets.\nThe set qos-group is supported only on an ingress policy.
range: "0..512"
"traffic-class": "integer", Sets the Traffic class identifiers on IPv4 or MPLS packets.
range: "0..63"
"destination-address": "string", Destination IPv4 address.
"precedence-tunnel": "string", Sets the precedence tunnel value for ipsec.
range: "0..7"
"source-address": "string", Source IPv4 address.
"discard-class": "integer", Sets the discard class on IPv4 or MPLS packets.\nThe discard-class can be used only in service policies\nthat are attached in the ingress policy.
range: "0..7"
"dei-imposition": "integer", Set DEI imposition bit.
range: "0..1"
"atm-clp": [ null ] Set atm cell-loss-priority bit.
}
}
SERVICE-POLICY - Update
Update operation of resource: service-policy
service-policybody object
ID of type name
ID of class-name class-type
Successful operation
Internal Error
Response Content-Types: application/json
SERVICE-POLICY - Create
Create operation of resource: service-policy
service-policybody object
ID of type name
ID of class-name class-type
Successful operation
Internal Error
Response Content-Types: application/json
SERVICE-POLICY - Delete
Delete operation of resource: service-policy
ID of type name
ID of class-name class-type
Successful operation
Internal Error
Response Content-Types: application/json
SERVICE-POLICY - Retrieve
Retrieve operation of resource: service-policy
ID of type name
ID of class-name class-type
Successful operation
Internal Error
CAC-LOCAL - Update
Update operation of resource: cac-local
cac-localbody object
ID of type name
ID of class-name class-type
Request Content-Types: application/json
Request Example
{ "flow-idle-timeout": "string", The interval after which a flow is removed,\nif there is no activity.\nIf timeout is 0 this flow does not expire. "units": "string", Rate units.
"value": "integer" Rate value.
range: "1..4294967295"
}, "units": "string", Rate units.
"value": "integer" Rate value.
range: "1..4294967295"
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
CAC-LOCAL - Create
Create operation of resource: cac-local
cac-localbody object
ID of type name
ID of class-name class-type
Request Content-Types: application/json
Request Example
{ "flow-idle-timeout": "string", The interval after which a flow is removed,\nif there is no activity.\nIf timeout is 0 this flow does not expire. "units": "string", Rate units.
"value": "integer" Rate value.
range: "1..4294967295"
}, "units": "string", Rate units.
"value": "integer" Rate value.
range: "1..4294967295"
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
CAC-LOCAL - Delete
Delete operation of resource: cac-local
ID of type name
ID of class-name class-type
Successful operation
Internal Error
Response Content-Types: application/json
CAC-LOCAL - Retrieve
Retrieve operation of resource: cac-local
ID of type name
ID of class-name class-type
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "flow-idle-timeout": "string", The interval after which a flow is removed,\nif there is no activity.\nIf timeout is 0 this flow does not expire. "units": "string", Rate units.
"value": "integer" Rate value.
range: "1..4294967295"
}, "units": "string", Rate units.
"value": "integer" Rate value.
range: "1..4294967295"
}
}
}
RATE - Update
Update operation of resource: rate
ratebody object
ID of type name
ID of class-name class-type
Successful operation
Internal Error
Response Content-Types: application/json
RATE - Create
Create operation of resource: rate
ratebody object
ID of type name
ID of class-name class-type
Successful operation
Internal Error
Response Content-Types: application/json
RATE - Delete
Delete operation of resource: rate
ID of type name
ID of class-name class-type
Successful operation
Internal Error
Response Content-Types: application/json
RATE - Retrieve
Retrieve operation of resource: rate
ID of type name
ID of class-name class-type
Successful operation
Internal Error
FLOW-RATE - Update
Update operation of resource: flow-rate
flow-ratebody object
ID of type name
ID of class-name class-type
Successful operation
Internal Error
Response Content-Types: application/json
FLOW-RATE - Create
Create operation of resource: flow-rate
flow-ratebody object
ID of type name
ID of class-name class-type
Successful operation
Internal Error
Response Content-Types: application/json
FLOW-RATE - Delete
Delete operation of resource: flow-rate
ID of type name
ID of class-name class-type
Successful operation
Internal Error
Response Content-Types: application/json
FLOW-RATE - Retrieve
Retrieve operation of resource: flow-rate
ID of type name
ID of class-name class-type
Successful operation
Internal Error
FLOW-PARAMS - Update
Update operation of resource: flow-params
flow-paramsbody object
ID of type name
ID of class-name class-type
Request Content-Types: application/json
Request Example
{ "max-flow": "integer", Max simultaneous flows monitored per policy class
range: "0..4096"
"interval-duration": "integer", Monitored interval duration.
units: "seconds"
"timeout": "integer", Declare a flow dead if no packets received in\nso much time
units: "seconds"
"history": "integer" Keep stats/metrics on box for so many intervals.
}
}
Successful operation
Internal Error
Response Content-Types: application/json
FLOW-PARAMS - Create
Create operation of resource: flow-params
flow-paramsbody object
ID of type name
ID of class-name class-type
Request Content-Types: application/json
Request Example
{ "max-flow": "integer", Max simultaneous flows monitored per policy class
range: "0..4096"
"interval-duration": "integer", Monitored interval duration.
units: "seconds"
"timeout": "integer", Declare a flow dead if no packets received in\nso much time
units: "seconds"
"history": "integer" Keep stats/metrics on box for so many intervals.
}
}
Successful operation
Internal Error
Response Content-Types: application/json
FLOW-PARAMS - Delete
Delete operation of resource: flow-params
ID of type name
ID of class-name class-type
Successful operation
Internal Error
Response Content-Types: application/json
FLOW-PARAMS - Retrieve
Retrieve operation of resource: flow-params
ID of type name
ID of class-name class-type
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "max-flow": "integer", Max simultaneous flows monitored per policy class
range: "0..4096"
"interval-duration": "integer", Monitored interval duration.
units: "seconds"
"timeout": "integer", Declare a flow dead if no packets received in\nso much time
units: "seconds"
"history": "integer" Keep stats/metrics on box for so many intervals.
}
}
METRICS-IPCBR - Update
Update operation of resource: metrics-ipcbr
metrics-ipcbrbody object
ID of type name
ID of class-name class-type
Request Content-Types: application/json
Request Example
{ "layer3": "integer", Nominal rate specified at the L3 (IP).
units: "bps"
"media": "integer", Nominal data rate of the media flow (ip payload).
range: "1..3000000000"
units: "bps"
"packet": "integer" Nominal IP layer packet rate (in pps).
units: "pps"
}, "count-in-layer3": "integer", Nominal number of media packets in an IP payload.
range: "1..64"
units: "packets"
"size": "integer" Nominal size of the media-packet.
units: "bytes"
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
METRICS-IPCBR - Create
Create operation of resource: metrics-ipcbr
metrics-ipcbrbody object
ID of type name
ID of class-name class-type
Request Content-Types: application/json
Request Example
{ "layer3": "integer", Nominal rate specified at the L3 (IP).
units: "bps"
"media": "integer", Nominal data rate of the media flow (ip payload).
range: "1..3000000000"
units: "bps"
"packet": "integer" Nominal IP layer packet rate (in pps).
units: "pps"
}, "count-in-layer3": "integer", Nominal number of media packets in an IP payload.
range: "1..64"
units: "packets"
"size": "integer" Nominal size of the media-packet.
units: "bytes"
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
METRICS-IPCBR - Delete
Delete operation of resource: metrics-ipcbr
ID of type name
ID of class-name class-type
Successful operation
Internal Error
Response Content-Types: application/json
METRICS-IPCBR - Retrieve
Retrieve operation of resource: metrics-ipcbr
ID of type name
ID of class-name class-type
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "layer3": "integer", Nominal rate specified at the L3 (IP).
units: "bps"
"media": "integer", Nominal data rate of the media flow (ip payload).
range: "1..3000000000"
units: "bps"
"packet": "integer" Nominal IP layer packet rate (in pps).
units: "pps"
}, "count-in-layer3": "integer", Nominal number of media packets in an IP payload.
range: "1..64"
units: "packets"
"size": "integer" Nominal size of the media-packet.
units: "bytes"
}
}
}
RATE - Update
Update operation of resource: rate
ratebody object
ID of type name
ID of class-name class-type
Request Content-Types: application/json
Request Example
{ "layer3": "integer", Nominal rate specified at the L3 (IP).
units: "bps"
"media": "integer", Nominal data rate of the media flow (ip payload).
range: "1..3000000000"
units: "bps"
"packet": "integer" Nominal IP layer packet rate (in pps).
units: "pps"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
RATE - Create
Create operation of resource: rate
ratebody object
ID of type name
ID of class-name class-type
Request Content-Types: application/json
Request Example
{ "layer3": "integer", Nominal rate specified at the L3 (IP).
units: "bps"
"media": "integer", Nominal data rate of the media flow (ip payload).
range: "1..3000000000"
units: "bps"
"packet": "integer" Nominal IP layer packet rate (in pps).
units: "pps"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
RATE - Delete
Delete operation of resource: rate
ID of type name
ID of class-name class-type
Successful operation
Internal Error
Response Content-Types: application/json
RATE - Retrieve
Retrieve operation of resource: rate
ID of type name
ID of class-name class-type
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "layer3": "integer", Nominal rate specified at the L3 (IP).
units: "bps"
"media": "integer", Nominal data rate of the media flow (ip payload).
range: "1..3000000000"
units: "bps"
"packet": "integer" Nominal IP layer packet rate (in pps).
units: "pps"
}
}
MEDIA-PACKET - Update
Update operation of resource: media-packet
media-packetbody object
ID of type name
ID of class-name class-type
Successful operation
Internal Error
Response Content-Types: application/json
MEDIA-PACKET - Create
Create operation of resource: media-packet
media-packetbody object
ID of type name
ID of class-name class-type
Successful operation
Internal Error
Response Content-Types: application/json
MEDIA-PACKET - Delete
Delete operation of resource: media-packet
ID of type name
ID of class-name class-type
Successful operation
Internal Error
Response Content-Types: application/json
MEDIA-PACKET - Retrieve
Retrieve operation of resource: media-packet
ID of type name
ID of class-name class-type
Successful operation
Internal Error
REACT - Update
Update operation of resource: react
reactbody object
ID of type name
ID of class-name class-type
Request Content-Types: application/json
Request Example
{ "criterion-packet-rate": [ null ], React criterion packet rate.
"criterion-media-stop": [ null ], React criterion media stop.
"criterion-flow-count": [ null ], React criterion flow count. "group-count": "integer", Number of flows to reach before\ntriggering alarm
units: "number of flows"
"discrete": [ null ], Discrete alarm type.
"group-percent": "integer" Percent to reach before triggering alarm
units: "percentage"
},
"severity": "string" Severity of the alarm.
}, "less-than-equal": "string", Less than equal
"range": "string", Range
"greater-than-equal": "string", Greater than equal
"less-than": "string", Less than
"greater-than": "string" Greater than
}, "average": "integer", Trigger averaged over N intervals.
"immediate": [ null ] Immediate trigger.
}
},
"criterion-delay-factor": [ null ], React criterion delay factor.
"descrition": "string", String describing the react statement. "syslog": [ null ], Syslog.
"snmp": [ null ] SNMP.
},
"criterion-mrv": [ null ] React criterion mrv.
}
}
Successful operation
Internal Error
Response Content-Types: application/json
REACT - Create
Create operation of resource: react
reactbody object
ID of type name
ID of class-name class-type
Request Content-Types: application/json
Request Example
{ "criterion-packet-rate": [ null ], React criterion packet rate.
"criterion-media-stop": [ null ], React criterion media stop.
"criterion-flow-count": [ null ], React criterion flow count. "group-count": "integer", Number of flows to reach before\ntriggering alarm
units: "number of flows"
"discrete": [ null ], Discrete alarm type.
"group-percent": "integer" Percent to reach before triggering alarm
units: "percentage"
},
"severity": "string" Severity of the alarm.
}, "less-than-equal": "string", Less than equal
"range": "string", Range
"greater-than-equal": "string", Greater than equal
"less-than": "string", Less than
"greater-than": "string" Greater than
}, "average": "integer", Trigger averaged over N intervals.
"immediate": [ null ] Immediate trigger.
}
},
"criterion-delay-factor": [ null ], React criterion delay factor.
"descrition": "string", String describing the react statement. "syslog": [ null ], Syslog.
"snmp": [ null ] SNMP.
},
"criterion-mrv": [ null ] React criterion mrv.
}
}
Successful operation
Internal Error
Response Content-Types: application/json
REACT - Delete
Delete operation of resource: react
ID of type name
ID of class-name class-type
Successful operation
Internal Error
Response Content-Types: application/json
REACT - Retrieve
Retrieve operation of resource: react
ID of type name
ID of class-name class-type
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "criterion-packet-rate": [ null ], React criterion packet rate.
"criterion-media-stop": [ null ], React criterion media stop.
"criterion-flow-count": [ null ], React criterion flow count. "group-count": "integer", Number of flows to reach before\ntriggering alarm
units: "number of flows"
"discrete": [ null ], Discrete alarm type.
"group-percent": "integer" Percent to reach before triggering alarm
units: "percentage"
},
"severity": "string" Severity of the alarm.
}, "less-than-equal": "string", Less than equal
"range": "string", Range
"greater-than-equal": "string", Greater than equal
"less-than": "string", Less than
"greater-than": "string" Greater than
}, "average": "integer", Trigger averaged over N intervals.
"immediate": [ null ] Immediate trigger.
}
},
"criterion-delay-factor": [ null ], React criterion delay factor.
"descrition": "string", String describing the react statement. "syslog": [ null ], Syslog.
"snmp": [ null ] SNMP.
},
"criterion-mrv": [ null ] React criterion mrv.
}
}
ACTION - Update
Update operation of resource: action
actionbody object
ID of type name
ID of class-name class-type
Successful operation
Internal Error
Response Content-Types: application/json
ACTION - Create
Create operation of resource: action
actionbody object
ID of type name
ID of class-name class-type
Successful operation
Internal Error
Response Content-Types: application/json
ACTION - Delete
Delete operation of resource: action
ID of type name
ID of class-name class-type
Successful operation
Internal Error
Response Content-Types: application/json
ACTION - Retrieve
Retrieve operation of resource: action
ID of type name
ID of class-name class-type
Successful operation
Internal Error
ALARM - Update
Update operation of resource: alarm
alarmbody object
ID of type name
ID of class-name class-type
Request Content-Types: application/json
Request Example
{ "group-count": "integer", Number of flows to reach before\ntriggering alarm
units: "number of flows"
"discrete": [ null ], Discrete alarm type.
"group-percent": "integer" Percent to reach before triggering alarm
units: "percentage"
},
"severity": "string" Severity of the alarm.
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ALARM - Create
Create operation of resource: alarm
alarmbody object
ID of type name
ID of class-name class-type
Request Content-Types: application/json
Request Example
{ "group-count": "integer", Number of flows to reach before\ntriggering alarm
units: "number of flows"
"discrete": [ null ], Discrete alarm type.
"group-percent": "integer" Percent to reach before triggering alarm
units: "percentage"
},
"severity": "string" Severity of the alarm.
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ALARM - Delete
Delete operation of resource: alarm
ID of type name
ID of class-name class-type
Successful operation
Internal Error
Response Content-Types: application/json
ALARM - Retrieve
Retrieve operation of resource: alarm
ID of type name
ID of class-name class-type
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "group-count": "integer", Number of flows to reach before\ntriggering alarm
units: "number of flows"
"discrete": [ null ], Discrete alarm type.
"group-percent": "integer" Percent to reach before triggering alarm
units: "percentage"
},
"severity": "string" Severity of the alarm.
}
}
TYPE - Update
Update operation of resource: type
typebody object
ID of type name
ID of class-name class-type
Request Content-Types: application/json
Request Example
{ "group-count": "integer", Number of flows to reach before\ntriggering alarm
units: "number of flows"
"discrete": [ null ], Discrete alarm type.
"group-percent": "integer" Percent to reach before triggering alarm
units: "percentage"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TYPE - Create
Create operation of resource: type
typebody object
ID of type name
ID of class-name class-type
Request Content-Types: application/json
Request Example
{ "group-count": "integer", Number of flows to reach before\ntriggering alarm
units: "number of flows"
"discrete": [ null ], Discrete alarm type.
"group-percent": "integer" Percent to reach before triggering alarm
units: "percentage"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TYPE - Delete
Delete operation of resource: type
ID of type name
ID of class-name class-type
Successful operation
Internal Error
Response Content-Types: application/json
TYPE - Retrieve
Retrieve operation of resource: type
ID of type name
ID of class-name class-type
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "group-count": "integer", Number of flows to reach before\ntriggering alarm
units: "number of flows"
"discrete": [ null ], Discrete alarm type.
"group-percent": "integer" Percent to reach before triggering alarm
units: "percentage"
}
}
THRESHOLD - Update
Update operation of resource: threshold
thresholdbody object
ID of type name
ID of class-name class-type
Request Content-Types: application/json
Request Example
{ "less-than-equal": "string", Less than equal
"range": "string", Range
"greater-than-equal": "string", Greater than equal
"less-than": "string", Less than
"greater-than": "string" Greater than
}, "average": "integer", Trigger averaged over N intervals.
"immediate": [ null ] Immediate trigger.
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD - Create
Create operation of resource: threshold
thresholdbody object
ID of type name
ID of class-name class-type
Request Content-Types: application/json
Request Example
{ "less-than-equal": "string", Less than equal
"range": "string", Range
"greater-than-equal": "string", Greater than equal
"less-than": "string", Less than
"greater-than": "string" Greater than
}, "average": "integer", Trigger averaged over N intervals.
"immediate": [ null ] Immediate trigger.
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD - Delete
Delete operation of resource: threshold
ID of type name
ID of class-name class-type
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD - Retrieve
Retrieve operation of resource: threshold
ID of type name
ID of class-name class-type
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "less-than-equal": "string", Less than equal
"range": "string", Range
"greater-than-equal": "string", Greater than equal
"less-than": "string", Less than
"greater-than": "string" Greater than
}, "average": "integer", Trigger averaged over N intervals.
"immediate": [ null ] Immediate trigger.
}
}
}
TRIGGER-VALUE - Update
Update operation of resource: trigger-value
trigger-valuebody object
ID of type name
ID of class-name class-type
Request Content-Types: application/json
Request Example
{ "less-than-equal": "string", Less than equal
"range": "string", Range
"greater-than-equal": "string", Greater than equal
"less-than": "string", Less than
"greater-than": "string" Greater than
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TRIGGER-VALUE - Create
Create operation of resource: trigger-value
trigger-valuebody object
ID of type name
ID of class-name class-type
Request Content-Types: application/json
Request Example
{ "less-than-equal": "string", Less than equal
"range": "string", Range
"greater-than-equal": "string", Greater than equal
"less-than": "string", Less than
"greater-than": "string" Greater than
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TRIGGER-VALUE - Delete
Delete operation of resource: trigger-value
ID of type name
ID of class-name class-type
Successful operation
Internal Error
Response Content-Types: application/json
TRIGGER-VALUE - Retrieve
Retrieve operation of resource: trigger-value
ID of type name
ID of class-name class-type
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "less-than-equal": "string", Less than equal
"range": "string", Range
"greater-than-equal": "string", Greater than equal
"less-than": "string", Less than
"greater-than": "string" Greater than
}
}
TRIGGER-TYPE - Update
Update operation of resource: trigger-type
trigger-typebody object
ID of type name
ID of class-name class-type
Successful operation
Internal Error
Response Content-Types: application/json
TRIGGER-TYPE - Create
Create operation of resource: trigger-type
trigger-typebody object
ID of type name
ID of class-name class-type
Successful operation
Internal Error
Response Content-Types: application/json
TRIGGER-TYPE - Delete
Delete operation of resource: trigger-type
ID of type name
ID of class-name class-type
Successful operation
Internal Error
Response Content-Types: application/json
TRIGGER-TYPE - Retrieve
Retrieve operation of resource: trigger-type
ID of type name
ID of class-name class-type
Successful operation
Internal Error
PBR-REDIRECT - Update
Update operation of resource: pbr-redirect
pbr-redirectbody object
ID of type name
ID of class-name class-type
Request Content-Types: application/json
Request Example
{ "index": "integer", ASN2:index 2/4 byte (hex or decimal format)
range: "0..4294967295" "netmask": "string", IPv4 netmask.
"address": "string" IPv4 address.
},
"as-number": "integer" 2-byte/4-byte AS number
range: "1..4294967295"
}
}, "ipv4-next-hop": "string", IPv4 address.
"vrf": "string" IPv6 VRF.
}, "ipv6-next-hop": "string", IPv6 address.
"vrf": "string" IPv6 VRF.
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
PBR-REDIRECT - Create
Create operation of resource: pbr-redirect
pbr-redirectbody object
ID of type name
ID of class-name class-type
Request Content-Types: application/json
Request Example
{ "index": "integer", ASN2:index 2/4 byte (hex or decimal format)
range: "0..4294967295" "netmask": "string", IPv4 netmask.
"address": "string" IPv4 address.
},
"as-number": "integer" 2-byte/4-byte AS number
range: "1..4294967295"
}
}, "ipv4-next-hop": "string", IPv4 address.
"vrf": "string" IPv6 VRF.
}, "ipv6-next-hop": "string", IPv6 address.
"vrf": "string" IPv6 VRF.
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
PBR-REDIRECT - Delete
Delete operation of resource: pbr-redirect
ID of type name
ID of class-name class-type
Successful operation
Internal Error
Response Content-Types: application/json
PBR-REDIRECT - Retrieve
Retrieve operation of resource: pbr-redirect
ID of type name
ID of class-name class-type
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "index": "integer", ASN2:index 2/4 byte (hex or decimal format)
range: "0..4294967295" "netmask": "string", IPv4 netmask.
"address": "string" IPv4 address.
},
"as-number": "integer" 2-byte/4-byte AS number
range: "1..4294967295"
}
}, "ipv4-next-hop": "string", IPv4 address.
"vrf": "string" IPv6 VRF.
}, "ipv6-next-hop": "string", IPv6 address.
"vrf": "string" IPv6 VRF.
}
}
}
IPV4 - Update
Update operation of resource: ipv4
ipv4body object
ID of type name
ID of class-name class-type
Successful operation
Internal Error
Response Content-Types: application/json
IPV4 - Create
Create operation of resource: ipv4
ipv4body object
ID of type name
ID of class-name class-type
Successful operation
Internal Error
Response Content-Types: application/json
IPV4 - Delete
Delete operation of resource: ipv4
ID of type name
ID of class-name class-type
Successful operation
Internal Error
Response Content-Types: application/json
IPV4 - Retrieve
Retrieve operation of resource: ipv4
ID of type name
ID of class-name class-type
Successful operation
Internal Error
IPV6 - Update
Update operation of resource: ipv6
ipv6body object
ID of type name
ID of class-name class-type
Successful operation
Internal Error
Response Content-Types: application/json
IPV6 - Create
Create operation of resource: ipv6
ipv6body object
ID of type name
ID of class-name class-type
Successful operation
Internal Error
Response Content-Types: application/json
IPV6 - Delete
Delete operation of resource: ipv6
ID of type name
ID of class-name class-type
Successful operation
Internal Error
Response Content-Types: application/json
IPV6 - Retrieve
Retrieve operation of resource: ipv6
ID of type name
ID of class-name class-type
Successful operation
Internal Error
NEXT-HOP - Update
Update operation of resource: next-hop
next-hopbody object
ID of type name
ID of class-name class-type
Request Content-Types: application/json
Request Example
{ "index": "integer", ASN2:index 2/4 byte (hex or decimal format)
range: "0..4294967295" "netmask": "string", IPv4 netmask.
"address": "string" IPv4 address.
},
"as-number": "integer" 2-byte/4-byte AS number
range: "1..4294967295"
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
NEXT-HOP - Create
Create operation of resource: next-hop
next-hopbody object
ID of type name
ID of class-name class-type
Request Content-Types: application/json
Request Example
{ "index": "integer", ASN2:index 2/4 byte (hex or decimal format)
range: "0..4294967295" "netmask": "string", IPv4 netmask.
"address": "string" IPv4 address.
},
"as-number": "integer" 2-byte/4-byte AS number
range: "1..4294967295"
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
NEXT-HOP - Delete
Delete operation of resource: next-hop
ID of type name
ID of class-name class-type
Successful operation
Internal Error
Response Content-Types: application/json
NEXT-HOP - Retrieve
Retrieve operation of resource: next-hop
ID of type name
ID of class-name class-type
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "index": "integer", ASN2:index 2/4 byte (hex or decimal format)
range: "0..4294967295" "netmask": "string", IPv4 netmask.
"address": "string" IPv4 address.
},
"as-number": "integer" 2-byte/4-byte AS number
range: "1..4294967295"
}
}
}
ROUTE-TARGET - Update
Update operation of resource: route-target
route-targetbody object
ID of type name
ID of class-name class-type
Request Content-Types: application/json
Request Example
{ "index": "integer", ASN2:index 2/4 byte (hex or decimal format)
range: "0..4294967295" "netmask": "string", IPv4 netmask.
"address": "string" IPv4 address.
},
"as-number": "integer" 2-byte/4-byte AS number
range: "1..4294967295"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ROUTE-TARGET - Create
Create operation of resource: route-target
route-targetbody object
ID of type name
ID of class-name class-type
Request Content-Types: application/json
Request Example
{ "index": "integer", ASN2:index 2/4 byte (hex or decimal format)
range: "0..4294967295" "netmask": "string", IPv4 netmask.
"address": "string" IPv4 address.
},
"as-number": "integer" 2-byte/4-byte AS number
range: "1..4294967295"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ROUTE-TARGET - Delete
Delete operation of resource: route-target
ID of type name
ID of class-name class-type
Successful operation
Internal Error
Response Content-Types: application/json
ROUTE-TARGET - Retrieve
Retrieve operation of resource: route-target
ID of type name
ID of class-name class-type
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "index": "integer", ASN2:index 2/4 byte (hex or decimal format)
range: "0..4294967295" "netmask": "string", IPv4 netmask.
"address": "string" IPv4 address.
},
"as-number": "integer" 2-byte/4-byte AS number
range: "1..4294967295"
}
}
IPV4-ADDRESS - Update
Update operation of resource: ipv4-address
ipv4-addressbody object
ID of type name
ID of class-name class-type
Successful operation
Internal Error
Response Content-Types: application/json
IPV4-ADDRESS - Create
Create operation of resource: ipv4-address
ipv4-addressbody object
ID of type name
ID of class-name class-type
Successful operation
Internal Error
Response Content-Types: application/json
IPV4-ADDRESS - Delete
Delete operation of resource: ipv4-address
ID of type name
ID of class-name class-type
Successful operation
Internal Error
Response Content-Types: application/json
IPV4-ADDRESS - Retrieve
Retrieve operation of resource: ipv4-address
ID of type name
ID of class-name class-type
Successful operation
Internal Error
PBR-FORWARD - Update
Update operation of resource: pbr-forward
pbr-forwardbody object
ID of type name
ID of class-name class-type
Request Content-Types: application/json
Request Example
{ "default": [ null ], Use system default routing table. : { "ipv6-address": "string", IPv6 address.
"ipv4-address": "string", IPv4 address.
"vrf": "string" VRF name.
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
PBR-FORWARD - Create
Create operation of resource: pbr-forward
pbr-forwardbody object
ID of type name
ID of class-name class-type
Request Content-Types: application/json
Request Example
{ "default": [ null ], Use system default routing table. : { "ipv6-address": "string", IPv6 address.
"ipv4-address": "string", IPv4 address.
"vrf": "string" VRF name.
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
PBR-FORWARD - Delete
Delete operation of resource: pbr-forward
ID of type name
ID of class-name class-type
Successful operation
Internal Error
Response Content-Types: application/json
PBR-FORWARD - Retrieve
Retrieve operation of resource: pbr-forward
ID of type name
ID of class-name class-type
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "default": [ null ], Use system default routing table. : { "ipv6-address": "string", IPv6 address.
"ipv4-address": "string", IPv4 address.
"vrf": "string" VRF name.
}
}
}
NEXT-HOP - Update
Update operation of resource: next-hop
next-hopbody object
ID of type name
ID of class-name class-type
Request Content-Types: application/json
Request Example
{ : { "ipv6-address": "string", IPv6 address.
"ipv4-address": "string", IPv4 address.
"vrf": "string" VRF name.
}
}
Successful operation
Internal Error
Response Content-Types: application/json
NEXT-HOP - Create
Create operation of resource: next-hop
next-hopbody object
ID of type name
ID of class-name class-type
Request Content-Types: application/json
Request Example
{ : { "ipv6-address": "string", IPv6 address.
"ipv4-address": "string", IPv4 address.
"vrf": "string" VRF name.
}
}
Successful operation
Internal Error
Response Content-Types: application/json
NEXT-HOP - Delete
Delete operation of resource: next-hop
ID of type name
ID of class-name class-type
Successful operation
Internal Error
Response Content-Types: application/json
NEXT-HOP - Retrieve
Retrieve operation of resource: next-hop
ID of type name
ID of class-name class-type
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ : { "ipv6-address": "string", IPv6 address.
"ipv4-address": "string", IPv4 address.
"vrf": "string" VRF name.
}
}
SERVICE-FUNCTION-PATH - Update
Update operation of resource: service-function-path
service-function-pathbody object
ID of type name
ID of class-name class-type
Request Content-Types: application/json
Request Example
{ "index": "integer", Service function path index.
range: "1..255"
"path-id": "integer", Service function path id.
range: "1..16777215"
"metadata": "string" Service function path metadata name.
}
}
Successful operation
Internal Error
Response Content-Types: application/json
SERVICE-FUNCTION-PATH - Create
Create operation of resource: service-function-path
service-function-pathbody object
ID of type name
ID of class-name class-type
Request Content-Types: application/json
Request Example
{ "index": "integer", Service function path index.
range: "1..255"
"path-id": "integer", Service function path id.
range: "1..16777215"
"metadata": "string" Service function path metadata name.
}
}
Successful operation
Internal Error
Response Content-Types: application/json
SERVICE-FUNCTION-PATH - Delete
Delete operation of resource: service-function-path
ID of type name
ID of class-name class-type
Successful operation
Internal Error
Response Content-Types: application/json
SERVICE-FUNCTION-PATH - Retrieve
Retrieve operation of resource: service-function-path
ID of type name
ID of class-name class-type
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "index": "integer", Service function path index.
range: "1..255"
"path-id": "integer", Service function path id.
range: "1..16777215"
"metadata": "string" Service function path metadata name.
}
}
HTTP-ENRICHMENT - Update
Update operation of resource: http-enrichment
http-enrichmentbody object
ID of type name
ID of class-name class-type
Successful operation
Internal Error
Response Content-Types: application/json
HTTP-ENRICHMENT - Create
Create operation of resource: http-enrichment
http-enrichmentbody object
ID of type name
ID of class-name class-type
Successful operation
Internal Error
Response Content-Types: application/json
HTTP-ENRICHMENT - Delete
Delete operation of resource: http-enrichment
ID of type name
ID of class-name class-type
Successful operation
Internal Error
Response Content-Types: application/json
HTTP-ENRICHMENT - Retrieve
Retrieve operation of resource: http-enrichment
ID of type name
ID of class-name class-type
Successful operation
Internal Error